Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExpressionDataArray

The possible array return types of an expression.

Hierarchy

Indexable

The possible array return types of an expression.

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

__@iterator

  • Iterator

    Returns IterableIterator<SimpleExpressionData | ExpressionDataArray>

__@unscopables

  • __@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

concat

  • Combines two or more arrays.

    Parameters

    Returns (SimpleExpressionData | ExpressionDataArray)[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T[] | T)[]

      Additional items to add to the end of array1.

    Returns (SimpleExpressionData | ExpressionDataArray)[]

copyWithin

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

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

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SimpleExpressionData | ExpressionDataArray]>

every

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

    Parameters

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SimpleExpressionData | ExpressionDataArray

      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 this

filter

find

findIndex

  • findIndex(predicate: function): number
  • findIndex(predicate: function, thisArg: undefined): number
  • findIndex<Z>(predicate: function, thisArg: Z): number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SimpleExpressionData | ExpressionDataArray

      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

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

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SimpleExpressionData | ExpressionDataArray

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

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns SimpleExpressionData | ExpressionDataArray | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns (SimpleExpressionData | ExpressionDataArray)[]

shift

  • Removes the first element from an array and returns it.

    Returns SimpleExpressionData | ExpressionDataArray | undefined

slice

  • 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.

    Returns (SimpleExpressionData | ExpressionDataArray)[]

some

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

    Parameters

    Returns boolean

sort

  • sort(compareFn?: function): this

splice

  • 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 (SimpleExpressionData | ExpressionDataArray)[]

  • 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: (SimpleExpressionData | ExpressionDataArray)[]

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

    Returns (SimpleExpressionData | ExpressionDataArray)[]

toLocaleString

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

    Returns string

toString

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

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<SimpleExpressionData | ExpressionDataArray>

Generated using TypeDoc