Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IList<T>

Generic list interface for use in generated code.

Type parameters

  • T

Hierarchy

Indexable

[n: number]: T

Generic list interface for use in generated code.

Index

Properties

Array

Array: ArrayConstructor

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.

Methods

[Symbol.iterator]

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

[Symbol.unscopables]

  • [Symbol.unscopables](): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

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

at

  • at(index: number): T | undefined
  • Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.

    Parameters

    • index: number

    Returns T | undefined

clear

  • clear(): T[]
  • Returns T[]

concat

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

    Parameters

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

      Additional items to add to the end of array1.

    Returns T[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns T[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • 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: undefined | number

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

    Returns this

entries

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

    Returns IterableIterator<[number, T]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      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: T, index: number, array: T[]): unknown
        • Parameters

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

          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

fill

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

    Parameters

    • value: T

      value to fill array section with

    • Optional start: undefined | 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: undefined | number

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

    Returns this

filter

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

    Type parameters

    • S: T

    Parameters

    • callbackfn: function

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

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

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

          Returns value

    • 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: function

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

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

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

          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 T[]

find

  • find(predicate: function, thisArg?: any, fromIndex?: undefined | number): T | undefined
  • Parameters

    • predicate: function
        • (item: T, index: number, array: Array<T>): boolean
        • Parameters

          • item: T
          • index: number
          • array: Array<T>

          Returns boolean

    • Optional thisArg: any
    • Optional fromIndex: undefined | number

    Returns T | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      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: T, index: number, obj: T[]): unknown
        • Parameters

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

          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<U>(this: U[][][][][][][][], depth: 7): U[]
  • flat<U>(this: U[][][][][][][], depth: 6): U[]
  • flat<U>(this: U[][][][][][], depth: 5): U[]
  • flat<U>(this: U[][][][][], depth: 4): U[]
  • flat<U>(this: U[][][][], depth: 3): U[]
  • flat<U>(this: U[][][], depth: 2): U[]
  • flat<U>(this: U[][], depth?: undefined | 1): U[]
  • flat<U>(this: U[], depth: 0): U[]
  • flat<U>(depth?: undefined | number): any[]
  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • U

    Parameters

    • this: U[][][][][][][][]
    • depth: 7

      The maximum recursion depth

    Returns U[]

  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • U

    Parameters

    • this: U[][][][][][][]
    • depth: 6

      The maximum recursion depth

    Returns U[]

  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • U

    Parameters

    • this: U[][][][][][]
    • depth: 5

      The maximum recursion depth

    Returns U[]

  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • U

    Parameters

    • this: U[][][][][]
    • depth: 4

      The maximum recursion depth

    Returns U[]

  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • U

    Parameters

    • this: U[][][][]
    • depth: 3

      The maximum recursion depth

    Returns U[]

  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • U

    Parameters

    • this: U[][][]
    • depth: 2

      The maximum recursion depth

    Returns U[]

  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • U

    Parameters

    • this: U[][]
    • Optional depth: undefined | 1

      The maximum recursion depth

    Returns U[]

  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • U

    Parameters

    • this: U[]
    • depth: 0

      The maximum recursion depth

    Returns U[]

  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

    Type parameters

    • U

    Parameters

    • Optional depth: undefined | number

      The maximum recursion depth

    Returns any[]

flatMap

  • flatMap<U, This>(callback: function, 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

    Parameters

    • callback: function

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

        • (this: This, value: T, index: number, array: T[]): U | ReadonlyArray<U>
        • Parameters

          • this: This
          • value: T
          • index: number
          • array: T[]

          Returns U | ReadonlyArray<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: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

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

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

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

          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

includes

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

    Parameters

    • searchElement: T

      The element to search for.

    • Optional fromIndex: undefined | number

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

    Returns boolean

indexOf

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

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: undefined | number

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

    Returns number

join

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

    Parameters

    • Optional separator: undefined | 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: T, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: undefined | 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: function, 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: function

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

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

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

          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[]

pop

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

    Returns T | undefined

push

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

    Parameters

    • Rest ...items: T[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): T
  • reduce(callbackfn: function, initialValue: T): T
  • reduce<U>(callbackfn: function, 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: function

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

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

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

          Returns T

    Returns T

  • Parameters

    • callbackfn: function
        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

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

          Returns T

    • initialValue: T

    Returns T

  • 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: function

      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: T, currentIndex: number, array: T[]): U
        • Parameters

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

          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: function): T
  • reduceRight(callbackfn: function, initialValue: T): T
  • reduceRight<U>(callbackfn: function, 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: function

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

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

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

          Returns T

    Returns T

  • Parameters

    • callbackfn: function
        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

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

          Returns T

    • initialValue: T

    Returns T

  • 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: function

      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: T, currentIndex: number, array: T[]): U
        • Parameters

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

          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

remove

  • remove(value: T): boolean
  • Parameters

    • value: T

    Returns boolean

replace

  • replace(newItems: T[]): T[]
  • Parameters

    • newItems: T[]

    Returns T[]

reverse

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

    Returns T[]

shift

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

    Returns T | undefined

slice

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

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

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

    Returns T[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      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: T, index: number, array: T[]): unknown
        • Parameters

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

          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?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      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)

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): T[]
  • splice(start: number, deleteCount: number, ...items: T[]): T[]
  • 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: undefined | number

      The number of elements to remove.

    Returns T[]

  • 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: T[]

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

    Returns T[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

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

    Parameters

    • Rest ...items: T[]

      Elements to insert at the start of the Array.

    Returns number

values

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

    Returns IterableIterator<T>

Generated using TypeDoc