Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a list value in an Ion stream.

[1] https://amazon-ion.github.io/ion-docs/docs/spec.html#list

Hierarchy

  • __class<this>
    • List

Index

Constructors

constructor

  • new List(children: Value[], annotations?: string[]): List
  • Constructor.

    Parameters

    • children: Value[]

      Values that will be contained in the new list.

    • annotations: string[] = []

      An optional array of strings to associate with the items in children.

    Returns List

Properties

_ionAnnotations

_ionAnnotations: string[]

_ionType

_ionType: IonType

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Static Readonly [Symbol.species]

[Symbol.species]: ArrayConstructor

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<any>
  • Iterator

    Returns IterableIterator<any>

[Symbol.unscopables]

  • [Symbol.unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean

_setAnnotations

  • _setAnnotations(annotations: string[]): void
  • Parameters

    • annotations: string[]

    Returns void

_unsupportedOperation

  • _unsupportedOperation<T>(functionName: string): never
  • Type parameters

    Parameters

    • functionName: string

    Returns never

_valueEquals

  • _valueEquals(other: any, options?: { epsilon?: null | number; ignoreAnnotations?: boolean; ignoreTimestampPrecision?: boolean; onlyCompareIon?: boolean }): boolean
  • Parameters

    • other: any
    • options: { epsilon?: null | number; ignoreAnnotations?: boolean; ignoreTimestampPrecision?: boolean; onlyCompareIon?: boolean } = ...
      • Optional epsilon?: null | number
      • Optional ignoreAnnotations?: boolean
      • Optional ignoreTimestampPrecision?: boolean
      • Optional onlyCompareIon?: boolean

    Returns boolean

allFields

  • allFields(): [string, Value[]][]

as

bigIntValue

  • bigIntValue(): null | bigint
  • Returns null | bigint

booleanValue

  • booleanValue(): null | boolean
  • Returns null | boolean

concat

  • concat(...items: ConcatArray<any>[]): any[]
  • concat(...items: any[]): any[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<any>[]

      Additional items to add to the end of array1.

    Returns any[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: any[]

      Additional items to add to the end of array1.

    Returns any[]

copyWithin

  • copyWithin(target: number, start: number, end?: number): List
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: number

      If not specified, length of the this object is used as its default value.

    Returns List

dateValue

  • dateValue(): null | Date
  • Returns null | Date

decimalValue

deleteField

  • deleteField(name: string): boolean
  • Parameters

    • name: string

    Returns boolean

elements

entries

  • entries(): IterableIterator<[number, any]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, any]>

equals

  • equals(other: any, options?: { epsilon?: null | number }): boolean
  • Implementation of the dom.Value interface method equals()

    Parameters

    • other: any
    • options: { epsilon?: null | number } = ...
      • Optional epsilon?: null | number

    Returns boolean

every

  • every(callbackfn: (value: any, index: number, array: any[]) => unknown, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: (value: any, index: number, array: any[]) => unknown

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in the array until the callbackfn returns a value which is coercible to the Boolean value false, or until the end of the array.

        • (value: any, index: number, array: any[]): unknown
        • Parameters

          • value: any
          • index: number
          • array: any[]

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fieldNames

  • fieldNames(): string[]
  • Returns string[]

fields

  • fields(): [string, Value][]

fill

  • fill(value: any, start?: number, end?: number): List
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: any

      value to fill array section with

    • Optional start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns List

filter

  • filter<S>(callbackfn: (value: any, index: number, array: any[]) => value is S, thisArg?: any): S[]
  • filter(callbackfn: (value: any, index: number, array: any[]) => unknown, thisArg?: any): any[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: any

    Parameters

    • callbackfn: (value: any, index: number, array: any[]) => value is S

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: any, index: number, array: any[]): value is S
        • Parameters

          • value: any
          • index: number
          • array: any[]

          Returns value is S

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: (value: any, index: number, array: any[]) => unknown

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: any, index: number, array: any[]): unknown
        • Parameters

          • value: any
          • index: number
          • array: any[]

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns any[]

find

  • find<S>(predicate: (value: any, index: number, obj: any[]) => value is S, thisArg?: any): undefined | S
  • find(predicate: (value: any, index: number, obj: any[]) => unknown, thisArg?: any): any
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: any

    Parameters

    • predicate: (value: any, index: number, obj: any[]) => value is S

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (value: any, index: number, obj: any[]): value is S
        • Parameters

          • value: any
          • index: number
          • obj: any[]

          Returns value is S

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns undefined | S

  • Parameters

    • predicate: (value: any, index: number, obj: any[]) => unknown
        • (value: any, index: number, obj: any[]): unknown
        • Parameters

          • value: any
          • index: number
          • obj: any[]

          Returns unknown

    • Optional thisArg: any

    Returns any

findIndex

  • findIndex(predicate: (value: any, index: number, obj: any[]) => unknown, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: (value: any, index: number, obj: any[]) => unknown

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: any, index: number, obj: any[]): unknown
        • Parameters

          • value: any
          • index: number
          • obj: any[]

          Returns unknown

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

flat

  • flat<A, D>(depth?: D): FlatArray<A, D>[]
  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • A

    • D: number = 1

    Parameters

    • Optional depth: D

      The maximum recursion depth

    Returns FlatArray<A, D>[]

flatMap

  • flatMap<U, This>(callback: (value: any, index: number, array: any[]) => U | readonly U[], thisArg?: This): U[]
  • Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

    Type parameters

    • U

    • This = undefined

    Parameters

    • callback: (value: any, index: number, array: any[]) => U | readonly U[]

      A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

        • (value: any, index: number, array: any[]): U | readonly U[]
        • Parameters

          • value: any
          • index: number
          • array: any[]

          Returns U | readonly U[]

    • Optional thisArg: This

      An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

forEach

  • forEach(callbackfn: (value: any, index: number, array: any[]) => void, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: (value: any, index: number, array: any[]) => void

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: any, index: number, array: any[]): void
        • Parameters

          • value: any
          • index: number
          • array: any[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

get

getAll

getAnnotations

  • getAnnotations(): string[]
  • Returns string[]

getType

includes

  • includes(searchElement: any, fromIndex?: number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: any

      The element to search for.

    • Optional fromIndex: number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: any, fromIndex?: number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: any

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

ionEquals

  • ionEquals(other: Value, options?: { epsilon?: null | number; ignoreAnnotations?: boolean; ignoreTimestampPrecision?: boolean }): boolean
  • Implementation of the dom.Value interface method ionEquals()

    Parameters

    • other: Value
    • options: { epsilon?: null | number; ignoreAnnotations?: boolean; ignoreTimestampPrecision?: boolean } = ...
      • Optional epsilon?: null | number
      • Optional ignoreAnnotations?: boolean
      • Optional ignoreTimestampPrecision?: boolean

    Returns boolean

isNull

  • isNull(): boolean

join

  • join(separator?: string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: any, fromIndex?: number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: any

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: (value: any, index: number, array: any[]) => U, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: (value: any, index: number, array: any[]) => U

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: any, index: number, array: any[]): U
        • Parameters

          • value: any
          • index: number
          • array: any[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

numberValue

  • numberValue(): null | number
  • Returns null | number

pop

  • pop(): any
  • Removes the last element from an array and returns it.

    Returns any

push

  • push(...items: any[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: any[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any): any
  • reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any, initialValue: any): any
  • reduce<U>(callbackfn: (previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: any, currentValue: any, currentIndex: number, array: any[]): any
        • Parameters

          • previousValue: any
          • currentValue: any
          • currentIndex: number
          • array: any[]

          Returns any

    Returns any

  • Parameters

    • callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any
        • (previousValue: any, currentValue: any, currentIndex: number, array: any[]): any
        • Parameters

          • previousValue: any
          • currentValue: any
          • currentIndex: number
          • array: any[]

          Returns any

    • initialValue: any

    Returns any

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: any, currentIndex: number, array: any[]): U
        • Parameters

          • previousValue: U
          • currentValue: any
          • currentIndex: number
          • array: any[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any): any
  • reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any, initialValue: any): any
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: any, currentValue: any, currentIndex: number, array: any[]): any
        • Parameters

          • previousValue: any
          • currentValue: any
          • currentIndex: number
          • array: any[]

          Returns any

    Returns any

  • Parameters

    • callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any
        • (previousValue: any, currentValue: any, currentIndex: number, array: any[]): any
        • Parameters

          • previousValue: any
          • currentValue: any
          • currentIndex: number
          • array: any[]

          Returns any

    • initialValue: any

    Returns any

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: any, currentIndex: number, array: any[]): U
        • Parameters

          • previousValue: U
          • currentValue: any
          • currentIndex: number
          • array: any[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): any[]
  • Reverses the elements in an Array.

    Returns any[]

shift

  • shift(): any
  • Removes the first element from an array and returns it.

    Returns any

slice

  • slice(start?: number, end?: number): any[]
  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

    Returns any[]

some

  • some(callbackfn: (value: any, index: number, array: any[]) => unknown, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: (value: any, index: number, array: any[]) => unknown

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in the array until the callbackfn returns a value which is coercible to the Boolean value true, or until the end of the array.

        • (value: any, index: number, array: any[]): unknown
        • Parameters

          • value: any
          • index: number
          • array: any[]

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: (a: any, b: any) => number): List
  • Sorts an array.

    Parameters

    • Optional compareFn: (a: any, b: any) => number

      Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      [11,2,22,1].sort((a, b) => a - b)
      
        • (a: any, b: any): number
        • Parameters

          • a: any
          • b: any

          Returns number

    Returns List

splice

  • splice(start: number, deleteCount?: number): any[]
  • splice(start: number, deleteCount: number, ...items: any[]): any[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: number

      The number of elements to remove.

    Returns any[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: any[]

      Elements to insert into the array in place of the deleted elements.

    Returns any[]

stringValue

  • stringValue(): null | string
  • Returns null | string

timestampValue

toLocaleString

  • toLocaleString(): string
  • Returns a date converted to a string using the current locale.

    Returns string

toString

  • toString(): string

uInt8ArrayValue

  • uInt8ArrayValue(): null | Uint8Array
  • Returns null | Uint8Array

unshift

  • unshift(...items: any[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: any[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<any>
  • Returns an iterable of values in the array

    Returns IterableIterator<any>

writeTo

  • writeTo(writer: Writer): void

Static _fromJsValue

  • _fromJsValue(jsValue: any, annotations: string[]): Value
  • Parameters

    • jsValue: any
    • annotations: string[]

    Returns Value

Static _getIonType

Static from

  • from<T>(arrayLike: ArrayLike<T>): T[]
  • from<T, U>(arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[]
  • from<T>(iterable: Iterable<T> | ArrayLike<T>): T[]
  • from<T, U>(iterable: Iterable<T> | ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[]
  • Creates an array from an array-like object.

    Type parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like object to convert to an array.

    Returns T[]

  • Creates an array from an iterable object.

    Type parameters

    • T

    • U

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like object to convert to an array.

    • mapfn: (v: T, k: number) => U

      A mapping function to call on every element of the array.

        • (v: T, k: number): U
        • Parameters

          • v: T
          • k: number

          Returns U

    • Optional thisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns U[]

  • Creates an array from an iterable object.

    Type parameters

    • T

    Parameters

    • iterable: Iterable<T> | ArrayLike<T>

      An iterable object to convert to an array.

    Returns T[]

  • Creates an array from an iterable object.

    Type parameters

    • T

    • U

    Parameters

    • iterable: Iterable<T> | ArrayLike<T>

      An iterable object to convert to an array.

    • mapfn: (v: T, k: number) => U

      A mapping function to call on every element of the array.

        • (v: T, k: number): U
        • Parameters

          • v: T
          • k: number

          Returns U

    • Optional thisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns U[]

Static isArray

  • isArray(arg: any): arg is any[]
  • Parameters

    • arg: any

    Returns arg is any[]

Static of

  • of<T>(...items: T[]): T[]
  • Returns a new array from a set of elements.

    Type parameters

    • T

    Parameters

    • Rest ...items: T[]

      A set of elements to include in the new array object.

    Returns T[]