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.

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

Inherited from

Array.every

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1432

every(predicate, thisArg)

every(predicate, thisArg?): boolean

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

Parameters

• predicate

• 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

Inherited from

Array.every

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1441

fill()

fill(value, start?, end?): this

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

• value: any

value to fill array section with

• start?: 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?: number

index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

Inherited from

Array.fill

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:51

filter()

filter(predicate, thisArg)

filter<S>(predicate, thisArg?): S[]

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

Type Parameters

• S extends any

Parameters

• predicate

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

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

Inherited from

Array.filter

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1468

filter(predicate, thisArg)

filter(predicate, thisArg?): any[]

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

Parameters

• predicate

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

• 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

any[]

Inherited from

Array.filter

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1474

find()

find(predicate, thisArg)

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

• S extends any

Parameters

• predicate

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.

• 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

Inherited from

Array.find

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:29

find(predicate, thisArg)

find(predicate, thisArg?): any

Parameters

• predicate

• thisArg?: any

Returns

any

Inherited from

Array.find

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:30

findIndex()

findIndex(predicate, thisArg?): number

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

Parameters

• predicate

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.

• 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

Inherited from

Array.findIndex

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:41

findLast()

findLast(predicate, thisArg)

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

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

Type Parameters

• S extends any

Parameters

• predicate

findLast 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, findLast immediately returns that element value. Otherwise, findLast returns undefined.

• 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

Inherited from

Array.findLast

Defined in

node_modules/typescript/lib/lib.es2023.array.d.ts:29

findLast(predicate, thisArg)

findLast(predicate, thisArg?): any

Parameters

• predicate

• thisArg?: any

Returns

any

Inherited from

Array.findLast

Defined in

node_modules/typescript/lib/lib.es2023.array.d.ts:30

findLastIndex()

findLastIndex(predicate, thisArg?): number

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

Parameters

• predicate

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.

• 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

Inherited from

Array.findLastIndex

Defined in

node_modules/typescript/lib/lib.es2023.array.d.ts:41

flat()

flat<A, D>(this, depth?): FlatArray<A, D>[]

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

• depth?: D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

Array.flat

Defined in

node_modules/typescript/lib/lib.es2019.array.d.ts:75

flatMap()

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

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

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

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

Inherited from

Array.flatMap

Defined in

node_modules/typescript/lib/lib.es2019.array.d.ts:64

forEach()

forEach(callbackfn, thisArg?): void

Performs the specified action for each element in an array.

Parameters

• callbackfn

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

• 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

Inherited from

Array.forEach

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1456

has()

has(el): boolean

Check if set includes element

Parameters

• el: T

Element to look for

Returns

boolean

True if element was found, false otherwise

Defined in

src/aset.ts:52

includes()

includes(searchElement, fromIndex?): boolean

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

Parameters

• searchElement: any

The element to search for.

• fromIndex?: number

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

Returns

boolean

Inherited from

Array.includes

Defined in

node_modules/typescript/lib/lib.es2016.array.include.d.ts:25

indexOf()

indexOf(searchElement, fromIndex?): number

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

Parameters

• searchElement: any

The value to locate in the array.

• fromIndex?: number

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

Returns

number

Inherited from

Array.indexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1417

intersection()

intersection(set): ASet<T>

Create list of elements this set has in common with the comparison set

Parameters

• set: ASet<T>

Set to compare against

Returns

ASet<T>

Set of common elements

Defined in

src/aset.ts:61

isDisjointFrom()

isDisjointFrom(set): boolean

Check if this set has no elements in common with the comparison set

Parameters

• set: ASet<T>

Set to compare against

Returns

boolean

True if nothing in common, false otherwise

Defined in

src/aset.ts:70

isSubsetOf()

isSubsetOf(set): boolean

Check if all elements in this set are included in the comparison set

Parameters

• set: ASet<T>

Set to compare against

Returns

boolean

True if all elements are included, false otherwise

Defined in

src/aset.ts:79

isSuperset()

isSuperset(set): boolean

Check if all elements from comparison set are included in this set

Parameters

• set: ASet<T>

Set to compare against

Returns

boolean

True if all elements are included, false otherwise

Defined in

src/aset.ts:88

join()

join(separator?): string

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

Parameters

• separator?: string

A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited from

Array.join

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1360

keys()

keys(): IterableIterator<number>

Returns an iterable of keys in the array

Returns

IterableIterator<number>

Inherited from

Array.keys

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:68

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

Parameters

• searchElement: any

The value to locate in the array.

• fromIndex?: number

The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited from

Array.lastIndexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1423

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

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

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

Inherited from

Array.map

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1462

pop()

pop(): any

Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

any

Inherited from

Array.pop

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1338

push()

push(...items): number

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

Parameters

• ...items: any[]

New elements to add to the array.

Returns

number

Inherited from

Array.push

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1343

reduce()

reduce(callbackfn)

reduce(callbackfn): any

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

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

Returns

any

Inherited from

Array.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1480

reduce(callbackfn, initialValue)

reduce(callbackfn, initialValue): any

Parameters

• callbackfn

• initialValue: any

Returns

any

Inherited from

Array.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1481

reduce(callbackfn, initialValue)

reduce<U>(callbackfn, initialValue): U

Type Parameters

• U

Parameters

• callbackfn

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

Inherited from

Array.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1487

reduceRight()

reduceRight(callbackfn)

reduceRight(callbackfn): any

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

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

Returns

any

Inherited from

Array.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1493

reduceRight(callbackfn, initialValue)

reduceRight(callbackfn, initialValue): any

Parameters

• callbackfn

• initialValue: any

Returns

any

Inherited from

Array.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1494

reduceRight(callbackfn, initialValue)

reduceRight<U>(callbackfn, initialValue): U

Type Parameters

• U

Parameters

• callbackfn

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

Inherited from

Array.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1500

reverse()

reverse(): any[]

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

any[]

Inherited from

Array.reverse

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1365

shift()

shift(): any

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

any

Inherited from

Array.shift

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1370

slice()

slice(start?, end?): any[]

Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

Parameters

• start?: number

The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

• end?: number

The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

Returns

any[]

Inherited from

Array.slice

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1380

some()

some(predicate, thisArg?): boolean

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

Parameters

• predicate

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.

• 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

Inherited from

Array.some

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1450

sort()

sort(compareFn?): this

Sorts an array in place. This method mutates the array and returns a reference to the same array.

Parameters

• compareFn?

Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

[11,2,22,1].sort((a, b) => a - b)

Returns

this

Inherited from

Array.sort

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1391

splice()

splice(start, deleteCount)

splice(start, deleteCount?): any[]

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted 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.

Returns

any[]

An array containing the elements that were deleted.

Inherited from

Array.splice

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1398

splice(start, deleteCount, items)

splice(start, deleteCount, ...items): any[]

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted 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: any[]

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

Returns

any[]

An array containing the elements that were deleted.

Inherited from

Array.splice

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1406

symmetricDifference()

symmetricDifference(set): ASet<any>

Create list of elements that are only in one set but not both (XOR)

Parameters

• set: ASet<T>

Set to compare against

Returns

ASet<any>

New set of unique elements

Defined in

src/aset.ts:97

toLocaleString()

toLocaleString(): string

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

Returns

string

Inherited from

Array.toLocaleString

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1333

toReversed()

toReversed(): any[]

Returns a copy of an array with its elements reversed.

Returns

any[]

Inherited from

Array.toReversed

Defined in

node_modules/typescript/lib/lib.es2023.array.d.ts:46

toSorted()

toSorted(compareFn?): any[]

Returns a copy of an array with its elements sorted.

Parameters

• compareFn?

[11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22]

Returns

any[]

Inherited from

Array.toSorted

Defined in

node_modules/typescript/lib/lib.es2023.array.d.ts:57

toSpliced()

toSpliced(start, deleteCount, items)

toSpliced(start, deleteCount, ...items): any[]

Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.

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: any[]

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

Returns

any[]

The copied array.

Inherited from

Array.toSpliced

Defined in

node_modules/typescript/lib/lib.es2023.array.d.ts:66

toSpliced(start, deleteCount)

toSpliced(start, deleteCount?): any[]

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.

• deleteCount?: number

The number of elements to remove.

Returns

any[]

A copy of the original array with the remaining elements.

Inherited from

Array.toSpliced

Defined in

node_modules/typescript/lib/lib.es2023.array.d.ts:74

toString()

toString(): string

Returns a string representation of an array.

Returns

string

Inherited from

Array.toString

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1329

union()

union(set): ASet<any>

Create joined list of elements included in this & the comparison set

Parameters

• set: ASet<T> | T[]

Set join

Returns

ASet<any>

New set of both previous sets combined

Defined in

src/aset.ts:106

unshift()

unshift(...items): number

Inserts new elements at the start of an array, and returns the new length of the array.

Parameters

• ...items: any[]

Elements to insert at the start of the array.

Returns

number

Inherited from

Array.unshift

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1411

values()

values(): IterableIterator<any>

Returns an iterable of values in the array

Returns

IterableIterator<any>

Inherited from

Array.values

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:73

with()

with(index, value): any[]

Copies an array, then overwrites the value at the provided index with the given value. If the index is negative, then it replaces from the end of the array.

Parameters

• index: number

The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.

• value: any

The value to write into the copied array.

Returns

any[]

The copied array with the updated value.

Inherited from

Array.with

Defined in

node_modules/typescript/lib/lib.es2023.array.d.ts:85

from()

from(arrayLike)

static from<T>(arrayLike): T[]

Creates an array from an array-like object.

Type Parameters

• T

Parameters

• arrayLike: ArrayLike<T>

An array-like object to convert to an array.

Returns

T[]

Inherited from

Array.from

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:70

from(arrayLike, mapfn, thisArg)

static from<T, U>(arrayLike, mapfn, thisArg?): U[]

Creates an array from an iterable object.

Type Parameters

• T

• U

Parameters

• arrayLike: ArrayLike<T>

An array-like object to convert to an array.

• mapfn

A mapping function to call on every element of the array.

• thisArg?: any

Value of 'this' used to invoke the mapfn.

Returns

U[]

Inherited from

Array.from

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:78

from(iterable)

static from<T>(iterable): T[]

Creates an array from an iterable object.

Type Parameters

• T

Parameters

• iterable: Iterable<T> | ArrayLike<T>

An iterable object to convert to an array.

Returns

T[]

Inherited from

Array.from

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:81

from(iterable, mapfn, thisArg)

static from<T, U>(iterable, mapfn, thisArg?): U[]

Creates an array from an iterable object.

Type Parameters

• T

• U

Parameters

• iterable: Iterable<T> | ArrayLike<T>

An iterable object to convert to an array.

• mapfn

A mapping function to call on every element of the array.

• thisArg?: any

Value of 'this' used to invoke the mapfn.

Returns

U[]

Inherited from

Array.from

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:89

isArray()

static isArray(arg): arg is any[]

Parameters

• arg: any

Returns

arg is any[]

Inherited from

Array.isArray

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1512

of()

static of<T>(...items): T[]

Returns a new array from a set of elements.

Type Parameters

• T

Parameters

• ...items: T[]

A set of elements to include in the new array object.

Returns

T[]

Inherited from

Array.of

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:84