Interface ReadonlyJSONArray

A type definition for a readonly JSON array.

interface ReadonlyJSONArray {
    [unscopables]: {
        [unscopables]?: boolean;
        length?: boolean;
        [iterator]?: any;
        concat?: any;
        entries?: any;
        every?: any;
        filter?: any;
        find?: any;
        findIndex?: any;
        forEach?: any;
        includes?: any;
        indexOf?: any;
        join?: any;
        keys?: any;
        lastIndexOf?: any;
        map?: any;
        reduce?: any;
        reduceRight?: any;
        slice?: any;
        some?: any;
        toLocaleString?: any;
        toString?: any;
        values?: any;
    };
    length: number;
    [iterator](): IterableIterator<ReadonlyJSONValue>;
    concat(...items): ReadonlyJSONValue[];
    concat(...items): ReadonlyJSONValue[];
    entries(): IterableIterator<[number, ReadonlyJSONValue]>;
    every<S>(predicate, thisArg?): this is readonly S[];
    every(predicate, thisArg?): boolean;
    filter<S>(predicate, thisArg?): S[];
    filter(predicate, thisArg?): ReadonlyJSONValue[];
    find<S>(predicate, thisArg?): undefined | S;
    find(predicate, thisArg?): undefined | ReadonlyJSONValue;
    findIndex(predicate, thisArg?): number;
    forEach(callbackfn, thisArg?): void;
    includes(searchElement, fromIndex?): boolean;
    indexOf(searchElement, fromIndex?): number;
    join(separator?): string;
    keys(): IterableIterator<number>;
    lastIndexOf(searchElement, fromIndex?): number;
    map<U>(callbackfn, thisArg?): U[];
    reduce(callbackfn): ReadonlyJSONValue;
    reduce(callbackfn, initialValue): ReadonlyJSONValue;
    reduce<U>(callbackfn, initialValue): U;
    reduceRight(callbackfn): ReadonlyJSONValue;
    reduceRight(callbackfn, initialValue): ReadonlyJSONValue;
    reduceRight<U>(callbackfn, initialValue): U;
    slice(start?, end?): ReadonlyJSONValue[];
    some(predicate, thisArg?): boolean;
    toLocaleString(): string;
    toString(): string;
    values(): IterableIterator<ReadonlyJSONValue>;
}

Hierarchy

Properties

[unscopables] length

Methods

[iterator] concat entries every filter find findIndex forEach includes indexOf join keys lastIndexOf map reduce reduceRight slice some toLocaleString toString values

Properties

Readonly [unscopables]

[unscopables]: {
    [unscopables]?: boolean;
    length?: boolean;
    [iterator]?: any;
    concat?: any;
    entries?: any;
    every?: any;
    filter?: any;
    find?: any;
    findIndex?: any;
    forEach?: any;
    includes?: any;
    indexOf?: any;
    join?: any;
    keys?: any;
    lastIndexOf?: any;
    map?: any;
    reduce?: any;
    reduceRight?: any;
    slice?: any;
    some?: any;
    toLocaleString?: any;
    toString?: any;
    values?: any;
}

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

Type declaration

  • Optional Readonly [unscopables]?: boolean

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

  • Optional Readonly length?: boolean

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

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

[iterator]

  • [iterator](): IterableIterator<ReadonlyJSONValue>

  • Iterator of values in the array.

    Returns IterableIterator<ReadonlyJSONValue>

concat

  • concat(...items): ReadonlyJSONValue[]

  • Combines two or more arrays.

    Parameters

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

      Additional items to add to the end of array1.

    Returns ReadonlyJSONValue[]

  • concat(...items): ReadonlyJSONValue[]

  • Combines two or more arrays.

    Parameters

    Returns ReadonlyJSONValue[]

entries

  • entries(): IterableIterator<[number, ReadonlyJSONValue]>

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

    Returns IterableIterator<[number, ReadonlyJSONValue]>

every

  • every<S>(predicate, thisArg?): this is readonly S[]

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

    Type Parameters

    Parameters

    • predicate: ((value, index, array) => 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.

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

  • every(predicate, thisArg?): boolean

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

    Parameters

    • predicate: ((value, index, array) => 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.

    • 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, thisArg?): S[]

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

    Type Parameters

    Parameters

    • predicate: ((value, index, array) => 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.

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

  • filter(predicate, thisArg?): ReadonlyJSONValue[]

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

    Parameters

    • predicate: ((value, index, array) => unknown)

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

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

find

  • find<S>(predicate, thisArg?): undefined | S

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type Parameters

    Parameters

    • predicate: ((value, index, obj) => 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.

    • 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

  • find(predicate, thisArg?): undefined | ReadonlyJSONValue

  • Parameters

    • predicate: ((value, index, obj) => unknown)
    • Optional thisArg: any

    Returns undefined | ReadonlyJSONValue

findIndex

  • findIndex(predicate, thisArg?): number

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

    Parameters

    • predicate: ((value, index, obj) => 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.

    • 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

forEach

  • forEach(callbackfn, thisArg?): void

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

    Parameters

    • callbackfn: ((value, index, array) => void)

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

    • 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, fromIndex?): boolean

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

    Parameters

    • searchElement: ReadonlyJSONValue

      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, fromIndex?): number

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

    Parameters

    • searchElement: ReadonlyJSONValue

      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

  • 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, fromIndex?): number

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

    Parameters

    • searchElement: ReadonlyJSONValue

      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, thisArg?): 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, index, array) => U)

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

    • 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): ReadonlyJSONValue

  • 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

    Returns ReadonlyJSONValue

  • reduce(callbackfn, initialValue): ReadonlyJSONValue

  • Parameters

    Returns ReadonlyJSONValue

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

    Type Parameters

    • U

    Parameters

    • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

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

    • 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): ReadonlyJSONValue

  • 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

    Returns ReadonlyJSONValue

  • reduceRight(callbackfn, initialValue): ReadonlyJSONValue

  • Parameters

    Returns ReadonlyJSONValue

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

    Type Parameters

    • U

    Parameters

    • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

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

    • 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?, end?): ReadonlyJSONValue[]

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

some

  • some(predicate, thisArg?): boolean

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

    Parameters

    • predicate: ((value, index, array) => 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.

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

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

values

  • values(): IterableIterator<ReadonlyJSONValue>

  • Returns an iterable of values in the array

    Returns IterableIterator<ReadonlyJSONValue>

Settings

Member Visibility

Theme

On This Page

[unscopables]length[iterator]concatentrieseveryfilterfindfindIndexforEachincludesindexOfjoinkeyslastIndexOfmapreducereduceRightslicesometoLocaleStringtoStringvalues