Interface RecursiveReadonlyArray<ItemType>

interface RecursiveReadonlyArray<ItemType> {
    "[unscopables]": {
        "[iterator]"?: boolean;
        "[unscopables]"?: boolean;
        at?: boolean;
        concat?: boolean;
        entries?: boolean;
        every?: boolean;
        filter?: boolean;
        find?: boolean;
        findIndex?: boolean;
        findLast?: boolean;
        findLastIndex?: boolean;
        flat?: boolean;
        flatMap?: boolean;
        forEach?: boolean;
        includes?: boolean;
        indexOf?: boolean;
        join?: boolean;
        keys?: boolean;
        lastIndexOf?: boolean;
        length?: boolean;
        map?: boolean;
        reduce?: boolean;
        reduceRight?: boolean;
        slice?: boolean;
        some?: boolean;
        toLocaleString?: boolean;
        toReversed?: boolean;
        toSorted?: boolean;
        toSpliced?: boolean;
        toString?: boolean;
        values?: boolean;
        with?: boolean;
        readonly [key: number]: undefined | boolean;
    };
    length: number;
    "[iterator]"(): IterableIterator<
        RecursiveReadonlyArray<ItemType>
        | ItemType,
    >;
    at(index: number): undefined | RecursiveReadonlyArray<ItemType> | ItemType;
    concat(
        ...items: ConcatArray<RecursiveReadonlyArray<ItemType> | ItemType>[],
    ): (RecursiveReadonlyArray<ItemType> | ItemType)[];
    concat(
        ...items: (
            | RecursiveReadonlyArray<ItemType>
            | ItemType
            | ConcatArray<RecursiveReadonlyArray<ItemType> | ItemType>
        )[],
    ): (RecursiveReadonlyArray<ItemType> | ItemType)[];
    entries(): IterableIterator<
        [number, RecursiveReadonlyArray<ItemType> | ItemType],
    >;
    every<S>(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => value is S,
        thisArg?: any,
    ): this is readonly S[];
    every(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => unknown,
        thisArg?: any,
    ): boolean;
    filter<S>(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => value is S,
        thisArg?: any,
    ): S[];
    filter(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => unknown,
        thisArg?: any,
    ): (RecursiveReadonlyArray<ItemType> | ItemType)[];
    find<S>(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            obj: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => value is S,
        thisArg?: any,
    ): undefined | S;
    find(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            obj: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => unknown,
        thisArg?: any,
    ): undefined | RecursiveReadonlyArray<ItemType> | ItemType;
    findIndex(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            obj: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => unknown,
        thisArg?: any,
    ): number;
    findLast<S>(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => value is S,
        thisArg?: any,
    ): undefined | S;
    findLast(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => unknown,
        thisArg?: any,
    ): undefined | RecursiveReadonlyArray<ItemType> | ItemType;
    findLastIndex(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => unknown,
        thisArg?: any,
    ): number;
    flat<A, D extends number = 1>(this: A, depth?: D): FlatArray<A, D>[];
    flatMap<U, This = undefined>(
        callback: (
            this: This,
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => U | readonly U[],
        thisArg?: This,
    ): U[];
    forEach(
        callbackfn: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => void,
        thisArg?: any,
    ): void;
    includes(
        searchElement: RecursiveReadonlyArray<ItemType> | ItemType,
        fromIndex?: number,
    ): boolean;
    indexOf(
        searchElement: RecursiveReadonlyArray<ItemType> | ItemType,
        fromIndex?: number,
    ): number;
    join(separator?: string): string;
    keys(): IterableIterator<number>;
    lastIndexOf(
        searchElement: RecursiveReadonlyArray<ItemType> | ItemType,
        fromIndex?: number,
    ): number;
    map<U>(
        callbackfn: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => U,
        thisArg?: any,
    ): U[];
    reduce(
        callbackfn: (
            previousValue: RecursiveReadonlyArray<ItemType> | ItemType,
            currentValue: RecursiveReadonlyArray<ItemType> | ItemType,
            currentIndex: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => RecursiveReadonlyArray<ItemType> | ItemType,
    ): RecursiveReadonlyArray<ItemType> | ItemType;
    reduce(
        callbackfn: (
            previousValue: RecursiveReadonlyArray<ItemType> | ItemType,
            currentValue: RecursiveReadonlyArray<ItemType> | ItemType,
            currentIndex: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => RecursiveReadonlyArray<ItemType> | ItemType,
        initialValue: RecursiveReadonlyArray<ItemType> | ItemType,
    ): RecursiveReadonlyArray<ItemType> | ItemType;
    reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: RecursiveReadonlyArray<ItemType> | ItemType,
            currentIndex: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => U,
        initialValue: U,
    ): U;
    reduceRight(
        callbackfn: (
            previousValue: RecursiveReadonlyArray<ItemType> | ItemType,
            currentValue: RecursiveReadonlyArray<ItemType> | ItemType,
            currentIndex: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => RecursiveReadonlyArray<ItemType> | ItemType,
    ): RecursiveReadonlyArray<ItemType> | ItemType;
    reduceRight(
        callbackfn: (
            previousValue: RecursiveReadonlyArray<ItemType> | ItemType,
            currentValue: RecursiveReadonlyArray<ItemType> | ItemType,
            currentIndex: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => RecursiveReadonlyArray<ItemType> | ItemType,
        initialValue: RecursiveReadonlyArray<ItemType> | ItemType,
    ): RecursiveReadonlyArray<ItemType> | ItemType;
    reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: RecursiveReadonlyArray<ItemType> | ItemType,
            currentIndex: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => U,
        initialValue: U,
    ): U;
    slice(
        start?: number,
        end?: number,
    ): (RecursiveReadonlyArray<ItemType> | ItemType)[];
    some(
        predicate: (
            value: RecursiveReadonlyArray<ItemType> | ItemType,
            index: number,
            array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
        ) => unknown,
        thisArg?: any,
    ): boolean;
    toLocaleString(): string;
    toReversed(): (RecursiveReadonlyArray<ItemType> | ItemType)[];
    toSorted(
        compareFn?: (
            a: RecursiveReadonlyArray<ItemType> | ItemType,
            b: RecursiveReadonlyArray<ItemType> | ItemType,
        ) => number,
    ): (RecursiveReadonlyArray<ItemType> | ItemType)[];
    toSpliced(
        start: number,
        deleteCount: number,
        ...items: (RecursiveReadonlyArray<ItemType> | ItemType)[],
    ): (RecursiveReadonlyArray<ItemType> | ItemType)[];
    toSpliced(
        start: number,
        deleteCount?: number,
    ): (RecursiveReadonlyArray<ItemType> | ItemType)[];
    toString(): string;
    values(): IterableIterator<RecursiveReadonlyArray<ItemType> | ItemType>;
    with(
        index: number,
        value: RecursiveReadonlyArray<ItemType> | ItemType,
    ): (RecursiveReadonlyArray<ItemType> | ItemType)[];
    readonly [n: number]: RecursiveReadonlyArray<ItemType> | ItemType;
}

Type Parameters

  • ItemType

Hierarchy

Indexable

Properties

"[unscopables]": {
    "[iterator]"?: boolean;
    "[unscopables]"?: boolean;
    at?: boolean;
    concat?: boolean;
    entries?: boolean;
    every?: boolean;
    filter?: boolean;
    find?: boolean;
    findIndex?: boolean;
    findLast?: boolean;
    findLastIndex?: boolean;
    flat?: boolean;
    flatMap?: boolean;
    forEach?: boolean;
    includes?: boolean;
    indexOf?: boolean;
    join?: boolean;
    keys?: boolean;
    lastIndexOf?: boolean;
    length?: boolean;
    map?: boolean;
    reduce?: boolean;
    reduceRight?: boolean;
    slice?: boolean;
    some?: boolean;
    toLocaleString?: boolean;
    toReversed?: boolean;
    toSorted?: boolean;
    toSpliced?: boolean;
    toString?: boolean;
    values?: boolean;
    with?: boolean;
    readonly [key: number]: undefined | boolean;
}

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Type declaration

  • readonly [key: number]: undefined | boolean
  • Optional[iterator]?: boolean
  • Optional Readonly[unscopables]?: boolean

    Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

  • Optionalat?: boolean
  • Optionalconcat?: boolean
  • Optionalentries?: boolean
  • Optionalevery?: boolean
  • Optionalfilter?: boolean
  • Optionalfind?: boolean
  • OptionalfindIndex?: boolean
  • OptionalfindLast?: boolean
  • OptionalfindLastIndex?: boolean
  • Optionalflat?: boolean
  • OptionalflatMap?: boolean
  • OptionalforEach?: boolean
  • Optionalincludes?: boolean
  • OptionalindexOf?: boolean
  • Optionaljoin?: boolean
  • Optionalkeys?: boolean
  • OptionallastIndexOf?: boolean
  • Optional Readonlylength?: boolean

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

  • Optionalmap?: boolean
  • Optionalreduce?: boolean
  • OptionalreduceRight?: boolean
  • Optionalslice?: boolean
  • Optionalsome?: boolean
  • OptionaltoLocaleString?: boolean
  • OptionaltoReversed?: boolean
  • OptionaltoSorted?: boolean
  • OptionaltoSpliced?: boolean
  • OptionaltoString?: boolean
  • Optionalvalues?: boolean
  • Optionalwith?: boolean
length: number

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

Methods

  • Returns the item located at the specified index.

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

    Returns undefined | RecursiveReadonlyArray<ItemType> | ItemType

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

    Type Parameters

    • S

    Parameters

    • predicate: (
          value: RecursiveReadonlyArray<ItemType> | ItemType,
          index: number,
          array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
      ) => 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.

    • OptionalthisArg: 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 readonly S[]

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

    Parameters

    • predicate: (
          value: RecursiveReadonlyArray<ItemType> | ItemType,
          index: number,
          array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
      ) => 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.

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

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

    Type Parameters

    • S

    Parameters

    • predicate: (
          value: RecursiveReadonlyArray<ItemType> | ItemType,
          index: number,
          array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
      ) => 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.

    • OptionalthisArg: 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: RecursiveReadonlyArray<ItemType> | ItemType,
          index: number,
          array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
      ) => unknown

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

    • OptionalthisArg: 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 (RecursiveReadonlyArray<ItemType> | ItemType)[]

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: (
          value: RecursiveReadonlyArray<ItemType> | ItemType,
          index: number,
          obj: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
      ) => 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.

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

  • Returns the index of the last element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: (
          value: RecursiveReadonlyArray<ItemType> | ItemType,
          index: number,
          array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
      ) => unknown

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

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

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

    Type Parameters

    • A
    • D extends number = 1

    Parameters

    • this: A
    • Optionaldepth: D

      The maximum recursion depth

    Returns FlatArray<A, D>[]

  • 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: (
          this: This,
          value: RecursiveReadonlyArray<ItemType> | ItemType,
          index: number,
          array: (RecursiveReadonlyArray<ItemType> | ItemType)[],
      ) => 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.

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

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: (
          value: RecursiveReadonlyArray<ItemType> | ItemType,
          index: number,
          array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
      ) => void

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

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

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    Returns boolean

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

    Parameters

    • searchElement: RecursiveReadonlyArray<ItemType> | ItemType

      The value to locate in the array.

    • OptionalfromIndex: number

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

    Returns number

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

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

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

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

    Parameters

    • searchElement: RecursiveReadonlyArray<ItemType> | ItemType

      The value to locate in the array.

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

  • 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: RecursiveReadonlyArray<ItemType> | ItemType,
          index: number,
          array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
      ) => U

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

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

  • Returns a section of an array.

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

    • Optionalend: number

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

    Returns (RecursiveReadonlyArray<ItemType> | ItemType)[]

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • predicate: (
          value: RecursiveReadonlyArray<ItemType> | ItemType,
          index: number,
          array: readonly (RecursiveReadonlyArray<ItemType> | ItemType)[],
      ) => 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.

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

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

    Returns string

  • Copies an array and removes elements while, if necessary, inserting new elements in their place, returning the remaining 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.

    • ...items: (RecursiveReadonlyArray<ItemType> | ItemType)[]

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

    Returns (RecursiveReadonlyArray<ItemType> | ItemType)[]

    A copy of the original array with the remaining elements.

  • Copies an array and removes elements while returning the remaining elements.

    Parameters

    • start: number

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

    • OptionaldeleteCount: number

      The number of elements to remove.

    Returns (RecursiveReadonlyArray<ItemType> | ItemType)[]

    A copy of the original array with the remaining elements.

  • Returns a string representation of an array.

    Returns string