DisBot
    Preparing search index...

    Interface InputJsonArray

    Matches a JSON array. Unlike JsonArray, readonly arrays are assignable to this type.

    interface InputJsonArray {
        "[unscopables]": {
            "[iterator]"?: boolean;
            "[unscopables]"?: boolean;
            at?: boolean;
            concat?: boolean;
            entries?: boolean;
            every?: boolean;
            filter?: boolean;
            find?: boolean;
            findIndex?: 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;
            toString?: boolean;
            values?: boolean;
            readonly [key: number]: boolean;
        };
        length: number;
        "[iterator]"(): ArrayIterator<InputJsonValue>;
        at(index: number): InputJsonValue;
        concat(...items: ConcatArray<InputJsonValue>[]): InputJsonValue[];
        concat(
            ...items: (InputJsonValue | ConcatArray<InputJsonValue>)[],
        ): InputJsonValue[];
        entries(): ArrayIterator<[number, InputJsonValue]>;
        every<S extends InputJsonValue>(
            predicate: (
                value: InputJsonValue,
                index: number,
                array: readonly InputJsonValue[],
            ) => value is S,
            thisArg?: any,
        ): this is readonly S[];
        every(
            predicate: (
                value: InputJsonValue,
                index: number,
                array: readonly InputJsonValue[],
            ) => unknown,
            thisArg?: any,
        ): boolean;
        filter<S extends InputJsonValue>(
            predicate: (
                value: InputJsonValue,
                index: number,
                array: readonly InputJsonValue[],
            ) => value is S,
            thisArg?: any,
        ): S[];
        filter(
            predicate: (
                value: InputJsonValue,
                index: number,
                array: readonly InputJsonValue[],
            ) => unknown,
            thisArg?: any,
        ): InputJsonValue[];
        find<S extends InputJsonValue>(
            predicate: (
                value: InputJsonValue,
                index: number,
                obj: readonly InputJsonValue[],
            ) => value is S,
            thisArg?: any,
        ): S;
        find(
            predicate: (
                value: InputJsonValue,
                index: number,
                obj: readonly InputJsonValue[],
            ) => unknown,
            thisArg?: any,
        ): InputJsonValue;
        findIndex(
            predicate: (
                value: InputJsonValue,
                index: number,
                obj: readonly InputJsonValue[],
            ) => 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: InputJsonValue,
                index: number,
                array: InputJsonValue[],
            ) => U | readonly U[],
            thisArg?: This,
        ): U[];
        forEach(
            callbackfn: (
                value: InputJsonValue,
                index: number,
                array: readonly InputJsonValue[],
            ) => void,
            thisArg?: any,
        ): void;
        includes(searchElement: InputJsonValue, fromIndex?: number): boolean;
        indexOf(searchElement: InputJsonValue, fromIndex?: number): number;
        join(separator?: string): string;
        keys(): ArrayIterator<number>;
        lastIndexOf(searchElement: InputJsonValue, fromIndex?: number): number;
        map<U>(
            callbackfn: (
                value: InputJsonValue,
                index: number,
                array: readonly InputJsonValue[],
            ) => U,
            thisArg?: any,
        ): U[];
        reduce(
            callbackfn: (
                previousValue: InputJsonValue,
                currentValue: InputJsonValue,
                currentIndex: number,
                array: readonly InputJsonValue[],
            ) => InputJsonValue,
        ): InputJsonValue;
        reduce(
            callbackfn: (
                previousValue: InputJsonValue,
                currentValue: InputJsonValue,
                currentIndex: number,
                array: readonly InputJsonValue[],
            ) => InputJsonValue,
            initialValue: InputJsonValue,
        ): InputJsonValue;
        reduce<U>(
            callbackfn: (
                previousValue: U,
                currentValue: InputJsonValue,
                currentIndex: number,
                array: readonly InputJsonValue[],
            ) => U,
            initialValue: U,
        ): U;
        reduceRight(
            callbackfn: (
                previousValue: InputJsonValue,
                currentValue: InputJsonValue,
                currentIndex: number,
                array: readonly InputJsonValue[],
            ) => InputJsonValue,
        ): InputJsonValue;
        reduceRight(
            callbackfn: (
                previousValue: InputJsonValue,
                currentValue: InputJsonValue,
                currentIndex: number,
                array: readonly InputJsonValue[],
            ) => InputJsonValue,
            initialValue: InputJsonValue,
        ): InputJsonValue;
        reduceRight<U>(
            callbackfn: (
                previousValue: U,
                currentValue: InputJsonValue,
                currentIndex: number,
                array: readonly InputJsonValue[],
            ) => U,
            initialValue: U,
        ): U;
        slice(start?: number, end?: number): InputJsonValue[];
        some(
            predicate: (
                value: InputJsonValue,
                index: number,
                array: readonly InputJsonValue[],
            ) => unknown,
            thisArg?: any,
        ): boolean;
        toLocaleString(): string;
        toLocaleString(
            locales: string | string[],
            options?: NumberFormatOptions & DateTimeFormatOptions,
        ): string;
        toString(): string;
        values(): ArrayIterator<InputJsonValue>;
        readonly [n: number]: InputJsonValue;
    }

    Hierarchy

    Indexable

    Index

    Properties

    [unscopables] length

    Methods

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

    Properties

    "[unscopables]": {
        "[iterator]"?: boolean;
        "[unscopables]"?: boolean;
        at?: boolean;
        concat?: boolean;
        entries?: boolean;
        every?: boolean;
        filter?: boolean;
        find?: boolean;
        findIndex?: 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;
        toString?: boolean;
        values?: boolean;
        readonly [key: number]: 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]: 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
    • 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
    • OptionaltoString?: boolean
    • Optionalvalues?: boolean
    length: number

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

    Methods

    • Iterator of values in the array.

      Returns ArrayIterator<InputJsonValue>

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

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

      Returns ArrayIterator<[number, InputJsonValue]>

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

      Type Parameters

      Parameters

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

      Parameters

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

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

      Type Parameters

      Parameters

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

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

    • Parameters

      Returns InputJsonValue

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

      Parameters

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

      • searchElement: InputJsonValue

        The element to search for.

      • OptionalfromIndex: number

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

      Returns boolean

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

      Parameters

      • searchElement: InputJsonValue

        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 ArrayIterator<number>

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

      Parameters

      • searchElement: InputJsonValue

        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: InputJsonValue, index: number, array: readonly InputJsonValue[]) => 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[]

    • 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: InputJsonValue,
            currentValue: InputJsonValue,
            currentIndex: number,
            array: readonly InputJsonValue[],
        ) => InputJsonValue

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

      Returns InputJsonValue

    • Parameters

      Returns InputJsonValue

    • 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: InputJsonValue,
            currentIndex: number,
            array: readonly InputJsonValue[],
        ) => 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

    • 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: InputJsonValue,
            currentValue: InputJsonValue,
            currentIndex: number,
            array: readonly InputJsonValue[],
        ) => InputJsonValue

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

      Returns InputJsonValue

    • Parameters

      Returns InputJsonValue

    • 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: InputJsonValue,
            currentIndex: number,
            array: readonly InputJsonValue[],
        ) => 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

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

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

      Parameters

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

    • Parameters

      • locales: string | string[]
      • Optionaloptions: NumberFormatOptions & DateTimeFormatOptions

      Returns string

    • Returns a string representation of an array.

      Returns string

    • Returns an iterable of values in the array

      Returns ArrayIterator<InputJsonValue>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods