JsonArray

Interface: JsonArray

Represents JSON-serializable array

Hierarchy

• Array‹AnyJson›

  ↳ JsonArray

Indexable

• [ n: number]: AnyJson

Represents JSON-serializable array

Index

Properties

• Array
• length

Methods

• [Symbol.iterator]
• [Symbol.unscopables]
• concat
• copyWithin
• entries
• every
• fill
• filter
• find
• findIndex
• flat
• flatMap
• forEach
• includes
• indexOf
• join
• keys
• lastIndexOf
• map
• pop
• push
• reduce
• reduceRight
• reverse
• shift
• slice
• some
• sort
• splice
• toLocaleString
• toString
• unshift
• values

Properties

Array

• Array: ArrayConstructor

---

length

• length: number

Inherited from JsonArray.length

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

Methods

[Symbol.iterator]

▸ [Symbol.iterator](): IterableIterator‹AnyJson›

Inherited from JsonArray.[Symbol.iterator]

Iterator

Returns: IterableIterator‹AnyJson›

---

[Symbol.unscopables]

▸ [Symbol.unscopables](): object

Inherited from JsonArray.[Symbol.unscopables]

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

▸ concat(...items: ConcatArray‹AnyJson›[]): AnyJson[]

Inherited from JsonArray.concat

Combines two or more arrays.

Parameters:

Name	Type	Description
...items	ConcatArray‹AnyJson›[]	Additional items to add to the end of array1.

Returns: AnyJson[]

▸ concat(...items: T | ConcatArray‹T›[]): AnyJson[]

Inherited from JsonArray.concat

Combines two or more arrays.

Parameters:

Name	Type	Description
...items	T | ConcatArray‹T›[]	Additional items to add to the end of array1.

Returns: AnyJson[]

---

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from JsonArray.copyWithin

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:

Name	Type	Description
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.
end?	undefined | number	If not specified, length of the this object is used as its default value.

Returns: this

---

entries

▸ entries(): IterableIterator‹[number, AnyJson]›

Inherited from JsonArray.entries

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

Returns: IterableIterator‹[number, AnyJson]›

---

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from JsonArray.every

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

Parameters:

▪ callbackfn: function

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

▸ (value: AnyJson, index: number, array: AnyJson[]): unknown

Parameters:

Name	Type
value	AnyJson
index	number
array	AnyJson[]

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

---

fill

▸ fill(value: AnyJson, start?: undefined | number, end?: undefined | number): this

Inherited from JsonArray.fill

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

Parameters:

Name	Type	Description
value	AnyJson	value to fill array section with
start?	undefined | 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.
end?	undefined | number	index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

---

filter

▸ filter<S>(callbackfn: function, thisArg?: any): S[]

Inherited from JsonArray.filter

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

Type parameters:

▪ S: AnyJson

Parameters:

▪ callbackfn: function

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

▸ (value: AnyJson, index: number, array: AnyJson[]): value is S

Parameters:

Name	Type
value	AnyJson
index	number
array	AnyJson[]

▪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: S[]

▸ filter(callbackfn: function, thisArg?: any): AnyJson[]

Inherited from JsonArray.filter

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

Parameters:

▪ callbackfn: function

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

▸ (value: AnyJson, index: number, array: AnyJson[]): unknown

Parameters:

Name	Type
value	AnyJson
index	number
array	AnyJson[]

▪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: AnyJson[]

---

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

Inherited from JsonArray.find

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

Type parameters:

▪ S: AnyJson

Parameters:

▪ predicate: function

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.

▸ (this: void, value: AnyJson, index: number, obj: AnyJson[]): value is S

Parameters:

Name	Type
this	void
value	AnyJson
index	number
obj	AnyJson[]

▪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: S | undefined

▸ find(predicate: function, thisArg?: any): AnyJson | undefined

Inherited from JsonArray.find

Parameters:

▪ predicate: function

▸ (value: AnyJson, index: number, obj: AnyJson[]): unknown

Parameters:

Name	Type
value	AnyJson
index	number
obj	AnyJson[]

▪Optional thisArg: any

Returns: AnyJson | undefined

---

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from JsonArray.findIndex

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

Parameters:

▪ predicate: function

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.

▸ (value: AnyJson, index: number, obj: AnyJson[]): unknown

Parameters:

Name	Type
value	AnyJson
index	number
obj	AnyJson[]

▪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

---

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

Inherited from JsonArray.flat

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

Type parameters:

▪ U

Parameters:

Name	Type	Description
this	U[][][][][][][][]	-
depth	7	The maximum recursion depth

Returns: U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

Inherited from JsonArray.flat

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

Type parameters:

▪ U

Parameters:

Name	Type	Description
this	U[][][][][][][]	-
depth	6	The maximum recursion depth

Returns: U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

Inherited from JsonArray.flat

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

Type parameters:

▪ U

Parameters:

Name	Type	Description
this	U[][][][][][]	-
depth	5	The maximum recursion depth

Returns: U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

Inherited from JsonArray.flat

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

Type parameters:

▪ U

Parameters:

Name	Type	Description
this	U[][][][][]	-
depth	4	The maximum recursion depth

Returns: U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

Inherited from JsonArray.flat

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

Type parameters:

▪ U

Parameters:

Name	Type	Description
this	U[][][][]	-
depth	3	The maximum recursion depth

Returns: U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

Inherited from JsonArray.flat

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

Type parameters:

▪ U

Parameters:

Name	Type	Description
this	U[][][]	-
depth	2	The maximum recursion depth

Returns: U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

Inherited from JsonArray.flat

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

Type parameters:

▪ U

Parameters:

Name	Type	Description
this	U[][]	-
depth?	undefined | 1	The maximum recursion depth

Returns: U[]

▸ flat<U>(this: U[], depth: 0): U[]

Inherited from JsonArray.flat

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

Type parameters:

▪ U

Parameters:

Name	Type	Description
this	U[]	-
depth	0	The maximum recursion depth

Returns: U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from JsonArray.flat

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

▪ U

Parameters:

Name	Type	Description
depth?	undefined | number	The maximum recursion depth

Returns: any[]

---

flatMap

▸ flatMap<U, This>(callback: function, thisArg?: This): U[]

Inherited from JsonArray.flatMap

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

Parameters:

▪ callback: function

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

▸ (this: This, value: AnyJson, index: number, array: AnyJson[]): U | ReadonlyArray‹U›

Parameters:

Name	Type
this	This
value	AnyJson
index	number
array	AnyJson[]

▪Optional thisArg: 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[]

---

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from JsonArray.forEach

Performs the specified action for each element in an array.

Parameters:

▪ callbackfn: function

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

▸ (value: AnyJson, index: number, array: AnyJson[]): void

Parameters:

Name	Type
value	AnyJson
index	number
array	AnyJson[]

▪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: AnyJson, fromIndex?: undefined | number): boolean

Inherited from JsonArray.includes

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

Parameters:

Name	Type	Description
searchElement	AnyJson	The element to search for.
fromIndex?	undefined | number	The position in this array at which to begin searching for searchElement.

Returns: boolean

---

indexOf

▸ indexOf(searchElement: AnyJson, fromIndex?: undefined | number): number

Inherited from JsonArray.indexOf

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

Parameters:

Name	Type	Description
searchElement	AnyJson	The value to locate in the array.
fromIndex?	undefined | 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?: undefined | string): string

Inherited from JsonArray.join

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

Parameters:

Name	Type	Description
separator?	undefined | 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›

Inherited from JsonArray.keys

Returns an iterable of keys in the array

Returns: IterableIterator‹number›

---

lastIndexOf

▸ lastIndexOf(searchElement: AnyJson, fromIndex?: undefined | number): number

Inherited from JsonArray.lastIndexOf

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

Parameters:

Name	Type	Description
searchElement	AnyJson	The value to locate in the array.
fromIndex?	undefined | 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[]

Inherited from JsonArray.map

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters:

▪ U

Parameters:

▪ callbackfn: function

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

▸ (value: AnyJson, index: number, array: AnyJson[]): U

Parameters:

Name	Type
value	AnyJson
index	number
array	AnyJson[]

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

---

pop

▸ pop(): AnyJson | undefined

Inherited from JsonArray.pop

Removes the last element from an array and returns it.

Returns: AnyJson | undefined

---

push

▸ push(...items: AnyJson[]): number

Inherited from JsonArray.push

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

Parameters:

Name	Type	Description
...items	AnyJson[]	New elements of the Array.

Returns: number

---

reduce

▸ reduce(callbackfn: function): AnyJson

Inherited from JsonArray.reduce

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

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

▸ (previousValue: AnyJson, currentValue: AnyJson, currentIndex: number, array: AnyJson[]): AnyJson

Parameters:

Name	Type
previousValue	AnyJson
currentValue	AnyJson
currentIndex	number
array	AnyJson[]

Returns: AnyJson

▸ reduce(callbackfn: function, initialValue: AnyJson): AnyJson

Inherited from JsonArray.reduce

Parameters:

▪ callbackfn: function

▸ (previousValue: AnyJson, currentValue: AnyJson, currentIndex: number, array: AnyJson[]): AnyJson

Parameters:

Name	Type
previousValue	AnyJson
currentValue	AnyJson
currentIndex	number
array	AnyJson[]

▪ initialValue: AnyJson

Returns: AnyJson

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from JsonArray.reduce

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

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: AnyJson, currentIndex: number, array: AnyJson[]): U

Parameters:

Name	Type
previousValue	U
currentValue	AnyJson
currentIndex	number
array	AnyJson[]

▪ 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: function): AnyJson

Inherited from JsonArray.reduceRight

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

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

▸ (previousValue: AnyJson, currentValue: AnyJson, currentIndex: number, array: AnyJson[]): AnyJson

Parameters:

Name	Type
previousValue	AnyJson
currentValue	AnyJson
currentIndex	number
array	AnyJson[]

Returns: AnyJson

▸ reduceRight(callbackfn: function, initialValue: AnyJson): AnyJson

Inherited from JsonArray.reduceRight

Parameters:

▪ callbackfn: function

▸ (previousValue: AnyJson, currentValue: AnyJson, currentIndex: number, array: AnyJson[]): AnyJson

Parameters:

Name	Type
previousValue	AnyJson
currentValue	AnyJson
currentIndex	number
array	AnyJson[]

▪ initialValue: AnyJson

Returns: AnyJson

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from JsonArray.reduceRight

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

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: AnyJson, currentIndex: number, array: AnyJson[]): U

Parameters:

Name	Type
previousValue	U
currentValue	AnyJson
currentIndex	number
array	AnyJson[]

▪ 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

---

reverse

▸ reverse(): AnyJson[]

Inherited from JsonArray.reverse

Reverses the elements in an Array.

Returns: AnyJson[]

---

shift

▸ shift(): AnyJson | undefined

Inherited from JsonArray.shift

Removes the first element from an array and returns it.

Returns: AnyJson | undefined

---

slice

▸ slice(start?: undefined | number, end?: undefined | number): AnyJson[]

Inherited from JsonArray.slice

Returns a section of an array.

Parameters:

Name	Type	Description
start?	undefined | number	The beginning of the specified portion of the array.
end?	undefined | number	The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

Returns: AnyJson[]

---

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from JsonArray.some

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

Parameters:

▪ callbackfn: function

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

▸ (value: AnyJson, index: number, array: AnyJson[]): unknown

Parameters:

Name	Type
value	AnyJson
index	number
array	AnyJson[]

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

---

sort

▸ sort(compareFn?: undefined | function): this

Inherited from JsonArray.sort

Sorts an array.

Parameters:

Name	Type	Description
compareFn?	undefined | function	Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order. ts [11,2,22,1].sort((a, b) => a - b)

Returns: this

---

splice

▸ splice(start: number, deleteCount?: undefined | number): AnyJson[]

Inherited from JsonArray.splice

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name	Type	Description
start	number	The zero-based location in the array from which to start removing elements.
deleteCount?	undefined | number	The number of elements to remove.

Returns: AnyJson[]

▸ splice(start: number, deleteCount: number, ...items: AnyJson[]): AnyJson[]

Inherited from JsonArray.splice

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name	Type	Description
start	number	The zero-based location in the array from which to start removing elements.
deleteCount	number	The number of elements to remove.
...items	AnyJson[]	Elements to insert into the array in place of the deleted elements.

Returns: AnyJson[]

---

toLocaleString

▸ toLocaleString(): string

Inherited from JsonArray.toLocaleString

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

Returns: string

---

toString

▸ toString(): string

Inherited from JsonArray.toString

Returns a string representation of an array.

Returns: string

---

unshift

▸ unshift(...items: AnyJson[]): number

Inherited from JsonArray.unshift

Inserts new elements at the start of an array.

Parameters:

Name	Type	Description
...items	AnyJson[]	Elements to insert at the start of the Array.

Returns: number

---

values

▸ values(): IterableIterator‹AnyJson›

Inherited from JsonArray.values

Returns an iterable of values in the array

Returns: IterableIterator‹AnyJson›