Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReadonlyArray<T>

Type parameters

  • T

Hierarchy

Indexable

[n: number]: T

Index

Properties

Readonly length

length: number

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

Methods

concat

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

every

  • every<S>(predicate: (value: T, index: number, array: keyof T[]) => value is S, thisArg?: any): this is keyof S[]
  • every(predicate: (value: T, index: number, array: keyof T[]) => unknown, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Type parameters

    • S: T

    Parameters

    • predicate: (value: T, index: number, array: keyof T[]) => value is S

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

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

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

          Returns value is S

    • Optional thisArg: any

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

    Returns this is keyof S[]

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • predicate: (value: T, index: number, array: keyof T[]) => unknown

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

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

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

          Returns unknown

    • Optional thisArg: any

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

    Returns boolean

filter

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

    Type parameters

    • S: T

    Parameters

    • predicate: (value: T, index: number, array: keyof T[]) => value is S

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

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

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

          Returns value is S

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate 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

    • predicate: (value: T, index: number, array: keyof T[]) => unknown

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

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

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

          Returns unknown

    • Optional thisArg: any

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

    Returns T[]

forEach

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

    Parameters

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

      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: keyof T[]): void
        • Parameters

          • value: T
          • index: number
          • array: keyof 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

indexOf

  • indexOf(searchElement: T, fromIndex?: 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: 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

lastIndexOf

  • lastIndexOf(searchElement: T, fromIndex?: 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: 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: T, index: number, array: keyof T[]) => 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: T, index: number, array: keyof T[]) => 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: T, index: number, array: keyof T[]): U
        • Parameters

          • value: T
          • index: number
          • array: keyof 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[]

reduce

  • reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: keyof T[]) => T): T
  • reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: keyof T[]) => T, initialValue: T): T
  • reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: keyof T[]) => 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: T, currentValue: T, currentIndex: number, array: keyof T[]) => T

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

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

          Returns T

    Returns T

  • Parameters

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

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

          • previousValue: U
          • currentValue: T
          • currentIndex: number
          • array: keyof 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: (previousValue: T, currentValue: T, currentIndex: number, array: keyof T[]) => T): T
  • reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: keyof T[]) => T, initialValue: T): T
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: keyof T[]) => 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: T, currentValue: T, currentIndex: number, array: keyof T[]) => T

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

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

          Returns T

    Returns T

  • Parameters

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

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

          • previousValue: U
          • currentValue: T
          • currentIndex: number
          • array: keyof 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

slice

  • slice(start?: number, end?: number): T[]
  • 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 T[]

some

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

    Parameters

    • predicate: (value: T, index: number, array: keyof T[]) => unknown

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

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

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

          Returns unknown

    • Optional thisArg: any

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

    Returns boolean

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

Generated using TypeDoc