StringArray

An array of strings that's defined as

export class StringArray extends Array<string> {
    // ...
}

Notice how TypeDoc has substituted string for the generic type argument in all the methods inherited from Array. For example, the values method returns IterableIterator<string>.

Hierarchy

Array<string>
- StringArray

Indexable

[n: number]: string

Index

Constructors

StringArray.constructor

Properties

StringArray.[unscopables]StringArray.[species]StringArray.length

Constructors

constructor

new StringArray(arrayLength: number): StringArray

Parameters

```
arrayLength: number
```

Returns StringArray

new StringArray(...items: string[]): StringArray

Parameters

```
…items: string[]
```

Properties

`Readonly`[unscopables]

"[unscopables]": {
    find?: boolean;
    findIndex?: boolean;
    fill?: boolean;
    copyWithin?: boolean;
    "[iterator]"?: boolean;
    entries?: boolean;
    keys?: boolean;
    values?: boolean;
    "[unscopables]"?: boolean;
    includes?: boolean;
    flatMap?: boolean;
    flat?: boolean;
    at?: boolean;
    findLast?: boolean;
    findLastIndex?: boolean;
    toReversed?: boolean;
    toSorted?: boolean;
    toSpliced?: boolean;
    with?: boolean;
    length?: boolean;
    toString?: boolean;
    toLocaleString?: boolean;
    pop?: boolean;
    push?: boolean;
    concat?: boolean;
    join?: boolean;
    reverse?: boolean;
    shift?: boolean;
    slice?: boolean;
    sort?: boolean;
    splice?: boolean;
    unshift?: boolean;
    indexOf?: boolean;
    lastIndexOf?: boolean;
    every?: boolean;
    some?: boolean;
    forEach?: boolean;
    map?: boolean;
    filter?: boolean;
    reduce?: boolean;
    reduceRight?: boolean;
    [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

[key: number]: undefined | boolean
Optionalfind?: boolean
OptionalfindIndex?: boolean
Optionalfill?: boolean
OptionalcopyWithin?: boolean
Optional[iterator]?: boolean
Optionalentries?: boolean
Optionalkeys?: boolean
Optionalvalues?: 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.
Optionalincludes?: boolean
OptionalflatMap?: boolean
Optionalflat?: boolean
Optionalat?: boolean
OptionalfindLast?: boolean
OptionalfindLastIndex?: boolean
OptionaltoReversed?: boolean
OptionaltoSorted?: boolean
OptionaltoSpliced?: boolean
Optionalwith?: boolean
Optionallength?: boolean
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
OptionaltoString?: boolean
OptionaltoLocaleString?: boolean
Optionalpop?: boolean
Optionalpush?: boolean
Optionalconcat?: boolean
Optionaljoin?: boolean
Optionalreverse?: boolean
Optionalshift?: boolean
Optionalslice?: boolean
Optionalsort?: boolean
Optionalsplice?: boolean
Optionalunshift?: boolean
OptionalindexOf?: boolean
OptionallastIndexOf?: boolean
Optionalevery?: boolean
Optionalsome?: boolean
OptionalforEach?: boolean
Optionalmap?: boolean
Optionalfilter?: boolean
Optionalreduce?: boolean
OptionalreduceRight?: boolean

`Static` `Readonly`[species]

"[species]": ArrayConstructor

length

length: number

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

Methods

customMethod

customMethod(): void

A method that extends the functionality of a basic JavaScript array.

Returns void

find

find<S extends string>(
    predicate: (value: string, index: number, obj: string[]) => value is S,
    thisArg?: any,
): undefined | S

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

Type Parameters

S extends string

Parameters

```
predicate: (value: string, index: number, obj: string[]) => 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 undefined | S

find(
    predicate: (value: string, index: number, obj: string[]) => unknown,
    thisArg?: any,
): undefined | string

Parameters

predicate: (value: string, index: number, obj: string[]) => unknown

```
OptionalthisArg: any
```

Returns undefined | string

findIndex

findIndex(
    predicate: (value: string, index: number, obj: string[]) => unknown,
    thisArg?: any,
): number

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

Parameters

```
predicate: (value: string, index: number, obj: string[]) => 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

fill

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

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

Parameters

```
value: string
```
value to fill array section with
```
Optionalstart: 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.
```
Optionalend: number
```
index to stop filling the array at. If end is negative, it is treated as length+end.

Returns this

copyWithin

copyWithin(target: number, start: number, end?: number): this

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

```
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.
```
Optionalend: number
```
If not specified, length of the this object is used as its default value.

Returns this

`Static`from

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

Creates an array from an array-like object.

Type Parameters

Parameters

```
arrayLike: ArrayLike<T>
```
An array-like object to convert to an array.

Returns T[]

from<T, U>(
    arrayLike: ArrayLike<T>,
    mapfn: (v: T, k: number) => U,
    thisArg?: any,
): U[]

Creates an array from an iterable object.

Type Parameters

Parameters

```
arrayLike: ArrayLike<T>
```
An array-like object to convert to an array.
```
mapfn: (v: T, k: number) => U
```
A mapping function to call on every element of the array.
```
OptionalthisArg: any
```
Value of 'this' used to invoke the mapfn.

Returns U[]

from<T>(iterable: Iterable<T, any, any> | ArrayLike<T>): T[]

Creates an array from an iterable object.

Type Parameters

Parameters

iterable: Iterable<T, any, any> | ArrayLike<T>

An iterable object to convert to an array.

Returns T[]

from<T, U>(
    iterable: Iterable<T, any, any> | ArrayLike<T>,
    mapfn: (v: T, k: number) => U,
    thisArg?: any,
): U[]

Creates an array from an iterable object.

Type Parameters

Parameters

iterable: Iterable<T, any, any> | ArrayLike<T>

An iterable object to convert to an array.

```
mapfn: (v: T, k: number) => U
```
A mapping function to call on every element of the array.
```
OptionalthisArg: any
```
Value of 'this' used to invoke the mapfn.

Returns U[]

`Static`of

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

Returns a new array from a set of elements.

Type Parameters

Parameters

```
…items: T[]
```
A set of elements to include in the new array object.

Returns T[]

[iterator]

"[iterator]"(): ArrayIterator<string>

Iterator

Returns ArrayIterator<string>

entries

entries(): ArrayIterator<[number, string]>

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

Returns ArrayIterator<[number, string]>

keys

keys(): ArrayIterator<number>

Returns an iterable of keys in the array

Returns ArrayIterator<number>

values

values(): ArrayIterator<string>

Returns an iterable of values in the array

Returns ArrayIterator<string>

includes

includes(searchElement: string, fromIndex?: number): boolean

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

Parameters

```
searchElement: string
```
The element to search for.
```
OptionalfromIndex: number
```
The position in this array at which to begin searching for searchElement.

Returns boolean

flatMap

flatMap<U, This = undefined>(
    callback: (
        this: This,
        value: string,
        index: number,
        array: string[],
    ) => U | readonly U[],
    thisArg?: This,
): 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: (this: This, value: string, index: number, array: string[]) => 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[]

flat

flat<A, D extends number = 1>(this: A, depth?: D): 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
```
```
Optionaldepth: D
```
The maximum recursion depth

Returns FlatArray<A, D>[]

at

at(index: number): undefined | string

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 | string

findLast

findLast<S extends string>(
    predicate: (value: string, index: number, array: string[]) => value is S,
    thisArg?: any,
): undefined | S

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

Type Parameters

S extends string

Parameters

```
predicate: (value: string, index: number, array: string[]) => value is S
```
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.
```
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 undefined | S

findLast(
    predicate: (value: string, index: number, array: string[]) => unknown,
    thisArg?: any,
): undefined | string

Parameters

predicate: (value: string, index: number, array: string[]) => unknown

```
OptionalthisArg: any
```

Returns undefined | string

findLastIndex

findLastIndex(
    predicate: (value: string, index: number, array: string[]) => unknown,
    thisArg?: any,
): number

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

Parameters

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

toReversed

toReversed(): string[]

Returns a copy of an array with its elements reversed.

Returns string[]

toSorted

toSorted(compareFn?: (a: string, b: string) => number): string[]

Returns a copy of an array with its elements sorted.

Parameters

```
OptionalcompareFn: (a: string, b: string) => number
```
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, UTF-16 code unit order.
```
[11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22]
```

Returns string[]

toSpliced

toSpliced(start: number, deleteCount: number, ...items: string[]): string[]

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: string[]
```
Elements to insert into the copied array in place of the deleted elements.

Returns string[]

The copied array.

toSpliced(start: number, deleteCount?: number): string[]

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

A copy of the original array with the remaining elements.

with

with(index: number, value: string): string[]

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: string
```
The value to write into the copied array.

Returns string[]

The copied array with the updated value.

toString

toString(): string

Returns a string representation of an array.

Returns string

toLocaleString

toLocaleString(): string

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

Returns string

toLocaleString(
    locales: string | string[],
    options?: NumberFormatOptions & DateTimeFormatOptions,
): string

Parameters

```
locales: string | string[]
```

Optionaloptions: NumberFormatOptions & DateTimeFormatOptions

Returns string

pop

pop(): undefined | string

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 undefined | string

push

push(...items: string[]): number

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

Parameters

```
…items: string[]
```
New elements to add to the array.

Returns number

concat

concat(...items: ConcatArray<string>[]): string[]

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

```
…items: ConcatArray<string>[]
```
Additional arrays and/or items to add to the end of the array.

Returns string[]

concat(...items: (string | ConcatArray<string>)[]): string[]

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

```
…items: (string | ConcatArray<string>)[]
```
Additional arrays and/or items to add to the end of the array.

Returns string[]

join

join(separator?: string): string

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

Parameters

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

reverse

reverse(): string[]

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

Returns string[]

shift

shift(): undefined | string

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 undefined | string

slice

slice(start?: number, end?: number): string[]

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

```
Optionalstart: number
```
The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
```
Optionalend: 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 string[]

sort

sort(compareFn?: (a: string, b: string) => number): this

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

Parameters

```
OptionalcompareFn: (a: string, b: string) => number
```
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, UTF-16 code unit order.
```
[11,2,22,1].sort((a, b) => a - b)
```

Returns this

splice

splice(start: number, deleteCount?: number): string[]

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.
```
OptionaldeleteCount: number
```
The number of elements to remove.

Returns string[]

An array containing the elements that were deleted.

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

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: string[]
```
Elements to insert into the array in place of the deleted elements.

Returns string[]

An array containing the elements that were deleted.

unshift

unshift(...items: string[]): number

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

Parameters

```
…items: string[]
```
Elements to insert at the start of the array.

Returns number

indexOf

indexOf(searchElement: string, fromIndex?: number): number

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

Parameters

```
searchElement: string
```
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

lastIndexOf

lastIndexOf(searchElement: string, fromIndex?: number): number

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

Parameters

```
searchElement: string
```
The value to locate in the array.
```
OptionalfromIndex: 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

every

every<S extends string>(
    predicate: (value: string, index: number, array: string[]) => value is S,
    thisArg?: any,
): this is S[]

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

Type Parameters

S extends string

Parameters

```
predicate: (value: string, index: number, array: string[]) => 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 S[]

every(
    predicate: (value: string, index: number, array: string[]) => unknown,
    thisArg?: any,
): boolean

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

Parameters

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

some

some(
    predicate: (value: string, index: number, array: string[]) => unknown,
    thisArg?: any,
): boolean

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

Parameters

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

forEach

forEach(
    callbackfn: (value: string, index: number, array: string[]) => void,
    thisArg?: any,
): void

Performs the specified action for each element in an array.

Parameters

```
callbackfn: (value: string, index: number, array: string[]) => 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

map

map<U>(
    callbackfn: (value: string, index: number, array: string[]) => U,
    thisArg?: any,
): U[]

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

Type Parameters

Parameters

```
callbackfn: (value: string, index: number, array: string[]) => 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[]

filter

filter<S extends string>(
    predicate: (value: string, index: number, array: string[]) => value is S,
    thisArg?: any,
): S[]

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

Type Parameters

S extends string

Parameters

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

filter(
    predicate: (value: string, index: number, array: string[]) => unknown,
    thisArg?: any,
): string[]

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

Parameters

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

reduce

reduce(
    callbackfn: (
        previousValue: string,
        currentValue: string,
        currentIndex: number,
        array: string[],
    ) => string,
): string

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

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

Returns string

reduce(
    callbackfn: (
        previousValue: string,
        currentValue: string,
        currentIndex: number,
        array: string[],
    ) => string,
    initialValue: string,
): string

Parameters

callbackfn: (
    previousValue: string,
    currentValue: string,
    currentIndex: number,
    array: string[],
) => string

```
initialValue: string
```

Returns string

reduce<U>(
    callbackfn: (
        previousValue: U,
        currentValue: string,
        currentIndex: number,
        array: string[],
    ) => U,
    initialValue: U,
): U

Type Parameters

Parameters

callbackfn: (
    previousValue: U,
    currentValue: string,
    currentIndex: number,
    array: string[],
) => 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: (
        previousValue: string,
        currentValue: string,
        currentIndex: number,
        array: string[],
    ) => string,
): string

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

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

Returns string

reduceRight(
    callbackfn: (
        previousValue: string,
        currentValue: string,
        currentIndex: number,
        array: string[],
    ) => string,
    initialValue: string,
): string

Parameters

callbackfn: (
    previousValue: string,
    currentValue: string,
    currentIndex: number,
    array: string[],
) => string

```
initialValue: string
```

Returns string

reduceRight<U>(
    callbackfn: (
        previousValue: U,
        currentValue: string,
        currentIndex: number,
        array: string[],
    ) => U,
    initialValue: U,
): U

Type Parameters

Parameters

callbackfn: (
    previousValue: U,
    currentValue: string,
    currentIndex: number,
    array: string[],
) => 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

`Static`isArray

isArray(arg: any): arg is any[]

Parameters

```
arg: any
```

Returns arg is any[]

`Static`fromAsync

fromAsync<T>(
    iterableOrArrayLike:
        | AsyncIterable<T, any, any>
        | Iterable<T | PromiseLike<T>, any, any>
        | ArrayLike<T | PromiseLike<T>>,
): Promise<T[]>

Creates an array from an async iterator or iterable object.

Type Parameters

Parameters

iterableOrArrayLike: 
    | AsyncIterable<T, any, any>
    | Iterable<T | PromiseLike<T>, any, any>
    | ArrayLike<T | PromiseLike<T>>

An async iterator or array-like object to convert to an array.

Returns Promise<T[]>

fromAsync<T, U>(
    iterableOrArrayLike:
        | AsyncIterable<T, any, any>
        | Iterable<T, any, any>
        | ArrayLike<T>,
    mapFn: (value: Awaited<T>, index: number) => U,
    thisArg?: any,
): Promise<Awaited<U>[]>

Creates an array from an async iterator or iterable object.

Type Parameters

Parameters

iterableOrArrayLike: AsyncIterable<T, any, any> | Iterable<T, any, any> | ArrayLike<T>

An async iterator or array-like object to convert to an array.

mapFn: (value: Awaited<T>, index: number) => U

```
OptionalthisArg: any
```
Value of 'this' used when executing mapfn.

StringArray

Hierarchy

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StringArray

Parameters

Returns StringArray

Properties

Readonly[unscopables]

Type declaration

[key: number]: undefined | boolean

Optionalfind?: boolean

OptionalfindIndex?: boolean

Optionalfill?: boolean

OptionalcopyWithin?: boolean

Optional[iterator]?: boolean

Optionalentries?: boolean

Optionalkeys?: boolean

Optionalvalues?: boolean

Optional Readonly[unscopables]?: boolean

Optionalincludes?: boolean

OptionalflatMap?: boolean

Optionalflat?: boolean

Optionalat?: boolean

OptionalfindLast?: boolean

OptionalfindLastIndex?: boolean

OptionaltoReversed?: boolean

OptionaltoSorted?: boolean

OptionaltoSpliced?: boolean

Optionalwith?: boolean

Optionallength?: boolean

OptionaltoString?: boolean

OptionaltoLocaleString?: boolean

Optionalpop?: boolean

Optionalpush?: boolean

Optionalconcat?: boolean

Optionaljoin?: boolean

Optionalreverse?: boolean

Optionalshift?: boolean

Optionalslice?: boolean

Optionalsort?: boolean

Optionalsplice?: boolean

Optionalunshift?: boolean

OptionalindexOf?: boolean

OptionallastIndexOf?: boolean

Optionalevery?: boolean

Optionalsome?: boolean

OptionalforEach?: boolean

Optionalmap?: boolean

Optionalfilter?: boolean

Optionalreduce?: boolean

OptionalreduceRight?: boolean

Static Readonly[species]

length

Methods

customMethod

Returns void

find

Type Parameters

Parameters

Returns undefined | S

Parameters

Returns undefined | string

findIndex

Parameters

Returns number

fill

Parameters

Returns this

copyWithin

Parameters

Returns this

Staticfrom

Type Parameters

`Readonly`[unscopables]

`Optional`find?: boolean

`Optional`findIndex?: boolean

`Optional`fill?: boolean

`Optional`copyWithin?: boolean

`Optional`[iterator]?: boolean

`Optional`entries?: boolean

`Optional`keys?: boolean

`Optional`values?: boolean

`Optional` `Readonly`[unscopables]?: boolean

`Optional`includes?: boolean

`Optional`flatMap?: boolean

`Optional`flat?: boolean

`Optional`at?: boolean

`Optional`findLast?: boolean

`Optional`findLastIndex?: boolean

`Optional`toReversed?: boolean

`Optional`toSorted?: boolean

`Optional`toSpliced?: boolean

`Optional`with?: boolean

`Optional`length?: boolean

`Optional`toString?: boolean

`Optional`toLocaleString?: boolean

`Optional`pop?: boolean

`Optional`push?: boolean

`Optional`concat?: boolean

`Optional`join?: boolean

`Optional`reverse?: boolean

`Optional`shift?: boolean

`Optional`slice?: boolean

`Optional`sort?: boolean

`Optional`splice?: boolean

`Optional`unshift?: boolean

`Optional`indexOf?: boolean

`Optional`lastIndexOf?: boolean

`Optional`every?: boolean

`Optional`some?: boolean

`Optional`forEach?: boolean

`Optional`map?: boolean

`Optional`filter?: boolean

`Optional`reduce?: boolean

`Optional`reduceRight?: boolean

`Static` `Readonly`[species]

`Static`from

`Static`of