DeepReadonlyArray<T> Interface

TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work

Extends

Inherited methods

Name Inherited from Description
__@iterator(): IterableIterator<DeepReadonly<T>> [ReadonlyArray.Symbol Iterator of values in the array.
concat(...items: ConcatArray<DeepReadonly<T>>[]): DeepReadonly<T>[] ReadonlyArray Combines two or more arrays.
concat(...items: T | ConcatArray<T>[]): DeepReadonly<T>[] ReadonlyArray Combines two or more arrays.
entries(): IterableIterator<[number, DeepReadonly<T>]> ReadonlyArray Returns an iterable of key, value pairs for every entry in the array
every(callbackfn: (value: DeepReadonly<T>, index: number, array: ReadonlyArray<DeepReadonly<T>>) => boolean, thisArg?: any): boolean ReadonlyArray Determines whether all the members of an array satisfy the specified test.
filter<S extends DeepReadonly<T>>(callbackfn: (value: DeepReadonly<T>, index: number, array: ReadonlyArray<DeepReadonly<T>>) => boolean, thisArg?: any): S extends DeepReadonly<T>[] ReadonlyArray Returns the elements of an array that meet the condition specified in a callback function.
filter(callbackfn: (value: DeepReadonly<T>, index: number, array: ReadonlyArray<DeepReadonly<T>>) => any, thisArg?: any): DeepReadonly<T>[] ReadonlyArray Returns the elements of an array that meet the condition specified in a callback function.
find<S extends DeepReadonly<T>>(predicate: (this: void, value: DeepReadonly<T>, index: number, obj: ReadonlyArray<DeepReadonly<T>>) => boolean, thisArg?: any): S extends DeepReadonly<T> | undefined ReadonlyArray Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
find(predicate: (value: DeepReadonly<T>, index: number, obj: ReadonlyArray<DeepReadonly<T>>) => boolean, thisArg?: any): DeepReadonly<T> | undefined ReadonlyArray  
findIndex(predicate: (value: DeepReadonly<T>, index: number, obj: ReadonlyArray<DeepReadonly<T>>) => boolean, thisArg?: any): number ReadonlyArray Returns the index of the first element in the array where predicate is true, and -1
otherwise.
forEach(callbackfn: (value: DeepReadonly<T>, index: number, array: ReadonlyArray<DeepReadonly<T>>) => void, thisArg?: any): void ReadonlyArray Performs the specified action for each element in an array.
includes(searchElement: DeepReadonly<T>, fromIndex?: number): boolean ReadonlyArray Determines whether an array includes a certain element, returning true or false as appropriate.
indexOf(searchElement: DeepReadonly<T>, fromIndex?: number): number ReadonlyArray Returns the index of the first occurrence of a value in an array.
join(separator?: string): string ReadonlyArray Adds all the elements of an array separated by the specified separator string.
keys(): IterableIterator<number> ReadonlyArray Returns an iterable of keys in the array
lastIndexOf(searchElement: DeepReadonly<T>, fromIndex?: number): number ReadonlyArray Returns the index of the last occurrence of a specified value in an array.
map<U>(callbackfn: (value: DeepReadonly<T>, index: number, array: ReadonlyArray<DeepReadonly<T>>) => U, thisArg?: any): U[] ReadonlyArray Calls a defined callback function on each element of an array, and returns an array that contains the results.
reduce(callbackfn: (previousValue: DeepReadonly<T>, currentValue: DeepReadonly<T>, currentIndex: number, array: ReadonlyArray<DeepReadonly<T>>) => DeepReadonly<T>): DeepReadonly<T> ReadonlyArray Calls the specified callback function for all the elements in an array.
reduce(callbackfn: (previousValue: DeepReadonly<T>, currentValue: DeepReadonly<T>, currentIndex: number, array: ReadonlyArray<DeepReadonly<T>>) => DeepReadonly<T>, initialValue: DeepReadonly<T>): DeepReadonly<T> ReadonlyArray  
reduce<U>(callbackfn: (previousValue: U, currentValue: DeepReadonly<T>, currentIndex: number, array: ReadonlyArray<DeepReadonly<T>>) => U, initialValue: U): U ReadonlyArray Calls the specified callback function for all the elements in an array.
reduceRight(callbackfn: (previousValue: DeepReadonly<T>, currentValue: DeepReadonly<T>, currentIndex: number, array: ReadonlyArray<DeepReadonly<T>>) => DeepReadonly<T>): DeepReadonly<T> ReadonlyArray Calls the specified callback function for all the elements in an array, in descending order.
reduceRight(callbackfn: (previousValue: DeepReadonly<T>, currentValue: DeepReadonly<T>, currentIndex: number, array: ReadonlyArray<DeepReadonly<T>>) => DeepReadonly<T>, initialValue: DeepReadonly<T>): DeepReadonly<T> ReadonlyArray  
reduceRight<U>(callbackfn: (previousValue: U, currentValue: DeepReadonly<T>, currentIndex: number, array: ReadonlyArray<DeepReadonly<T>>) => U, initialValue: U): U ReadonlyArray Calls the specified callback function for all the elements in an array, in descending order.
slice(start?: number, end?: number): DeepReadonly<T>[] ReadonlyArray Returns a section of an array.
some(callbackfn: (value: DeepReadonly<T>, index: number, array: ReadonlyArray<DeepReadonly<T>>) => boolean, thisArg?: any): boolean ReadonlyArray Determines whether the specified callback function returns true for any element of an array.
toLocaleString(): string ReadonlyArray Returns a string representation of an array.
toString(): string ReadonlyArray Returns a string representation of an array.
values(): IterableIterator<DeepReadonly<T>> ReadonlyArray Returns an iterable of values in the array

Inherited properties

Name Type Inherited from Description
length number ReadonlyArray Gets the length of the array.

Defined in

Last Updated: 10 September, 2019