Interface ReactiveArray<T>

A reactive array class.

The array interface here works similar to the builtin Array (i.e. T[]). The major difference is that one must use the get and set methods instead of using square brackets, i.e. use array.get(i) instead of array[i] and array.set(i, v) instead of array[i] = v. Not all builtin array methods are implemented right now, but most of them are.

Reads and writes to this array are reactive.

interface ReactiveArray<T> {
 length: number;
 at(index: number): T | undefined;
 concat(...values: T[]): ReactiveArray<T>;
 concat(...values: (T | ReadonlyReactiveArray<T> | T[])[]): ReactiveArray<T>;
 entries(): IterableIterator<[index: number, value: T]>;
 every(predicate: (value: T, index: number) => boolean): boolean;
 filter(
 predicate: (value: T, index: number) => value is U,
 ): ReactiveArray;
 filter(predicate: (value: T, index: number) => boolean): ReactiveArray<T>;
 find(predicate: (value: T, index: number) => value is U): U | undefined;
 find(predicate: (value: T, index: number) => boolean): T | undefined;
 findIndex(predicate: (value: T, index: number) => boolean): number;
 findLast(
 predicate: (value: T, index: number) => value is U,
 ): U | undefined;
 findLast(predicate: (value: T, index: number) => boolean): T | undefined;
 findLastIndex(predicate: (value: T, index: number) => boolean): number;
 flatMap(
 callback: (value: T, index: number) => U | readonly U[],
 ): ReactiveArray;
 forEach(callback: (value: T, index: number) => void): void;
 get(index: number): T | undefined;
 getItems(): T[];
 includes(value: T, fromIndex?: number): boolean;
 indexOf(value: T, fromIndex?: number): number;
 keys(): IterableIterator<number>;
 lastIndexOf(value: T): number;
 map(callback: (value: T, index: number) => U): ReactiveArray;
 pop(): T | undefined;
 push(...values: T[]): void;
 reduce(
 callback: (
 previousValue: T,
 currentValue: T,
 currentIndex: number,
 ) => T,
 ): T;
 reduce(
 callback: (
 previousValue: T,
 currentValue: T,
 currentIndex: number,
 ) => T,
 initialValue: T,
 ): T;
 reduce(
 callback: (
 previousValue: U,
 currentValue: T,
 currentIndex: number,
 ) => U,
 initialValue: U,
 ): U;
 reduceRight(
 callback: (
 previousValue: T,
 currentValue: T,
 currentIndex: number,
 ) => T,
 ): T;
 reduceRight(
 callback: (
 previousValue: T,
 currentValue: T,
 currentIndex: number,
 ) => T,
 initialValue: T,
 ): T;
 reduceRight(
 callback: (
 previousValue: U,
 currentValue: T,
 currentIndex: number,
 ) => U,
 initialValue: U,
 ): U;
 set(index: number, value: T): void;
 shift(): T | undefined;
 slice(start?: number): ReactiveArray<T>;
 slice(start: number, end?: number): ReactiveArray<T>;
 some(predicate: (value: T, index: number) => boolean): boolean;
 sort(compare: (a: T, b: T) => number): void;
 splice(start: number, deleteCount?: number): T[];
 splice(start: number, deleteCount: number, ...values: T[]): T[];
 unshift(...values: T[]): void;
 values(): IterableIterator<T>;
}

Type Parameters

Hierarchy (View Summary)

ReadonlyReactiveArray<T>
- ReactiveArray

Index

Properties

length

Methods

at

at(index: number): T | undefined
Returns the item at the given index, or undefined if the index is out of bounds. You can use negative indices to address items starting from the end of the array.

See also Array.at.
Parameters
- index: number
Returns T | undefined
Inherited from ReadonlyReactiveArray.at
- Defined in collections/array.ts:30

concat

concat(...values: T[]): ReactiveArray<T>
Returns a new array with values concatenated to the end of the current content.

See also Array.concat.
Parameters
- ...values: T[]
Returns ReactiveArray<T>
Inherited from ReadonlyReactiveArray.concat
- Defined in collections/array.ts:61
concat(...values: (T | ReadonlyReactiveArray<T> | T[])[]): ReactiveArray<T>
Returns a new array with values concatenated to the end of the current content.

See also Array.concat.
Parameters
- ...values: (T | ReadonlyReactiveArray<T> | T[])[]
Returns ReactiveArray<T>
Inherited from ReadonlyReactiveArray.concat
- Defined in collections/array.ts:68

entries

entries(): IterableIterator<[index: number, value: T]>
Returns an iterator over the [index, value] entries in this array.

Returns IterableIterator<[index: number, value: T]>
Inherited from ReadonlyReactiveArray.entries
- Defined in collections/array.ts:262

every

every(predicate: (value: T, index: number) => boolean): boolean
Returns true if the predicate is satisfied for every item in this array, false otherwise.

See also Array.every.
Parameters
- predicate: (value: T, index: number) => boolean
Returns boolean
Inherited from ReadonlyReactiveArray.every
- Defined in collections/array.ts:145

filter

filter(predicate: (value: T, index: number) => value is U): ReactiveArray
Returns a new array where only items are retained that fulfilled the given predicate.

See also Array.filter.
Type Parameters
- U
Parameters
- predicate: (value: T, index: number) => value is U
Returns ReactiveArray
Inherited from ReadonlyReactiveArray.filter
- Defined in collections/array.ts:159
filter(predicate: (value: T, index: number) => boolean): ReactiveArray<T>
Returns a new array where only items are retained that fulfilled the given predicate.

See also Array.filter.
Parameters
- predicate: (value: T, index: number) => boolean
Returns ReactiveArray<T>
Inherited from ReadonlyReactiveArray.filter
- Defined in collections/array.ts:166

find

find(predicate: (value: T, index: number) => value is U): U | undefined
Returns the first item that satisfies the given predicate, or undefined if there is no such item.

See also Array.find.
Type Parameters
- U
Parameters
- predicate: (value: T, index: number) => value is U
Returns U | undefined
Inherited from ReadonlyReactiveArray.find
- Defined in collections/array.ts:96
find(predicate: (value: T, index: number) => boolean): T | undefined
Returns the first item that satisfies the given predicate, or undefined if there is no such item.

See also Array.find.
Parameters
- predicate: (value: T, index: number) => boolean
Returns T | undefined
Inherited from ReadonlyReactiveArray.find
- Defined in collections/array.ts:103

findIndex

findIndex(predicate: (value: T, index: number) => boolean): number
Returns the index of the first item that satisfies the given predicate, -1 if no such item was found.

See also Array.findIndex.
Parameters
- predicate: (value: T, index: number) => boolean
Returns number
Inherited from ReadonlyReactiveArray.findIndex
- Defined in collections/array.ts:124

findLast

findLast(predicate: (value: T, index: number) => value is U): U | undefined
Returns the last item that satisfies the given predicate, or undefined if there is no such item.

See also Array.findLast.
Type Parameters
- U
Parameters
- predicate: (value: T, index: number) => value is U
Returns U | undefined
Inherited from ReadonlyReactiveArray.findLast
- Defined in collections/array.ts:110
findLast(predicate: (value: T, index: number) => boolean): T | undefined
Returns the last item that satisfies the given predicate, or undefined if there is no such item.

See also Array.findLast.
Parameters
- predicate: (value: T, index: number) => boolean
Returns T | undefined
Inherited from ReadonlyReactiveArray.findLast
- Defined in collections/array.ts:117

findLastIndex

findLastIndex(predicate: (value: T, index: number) => boolean): number
Returns the index of the first item that satisfies the given predicate, -1 if no such item was found.

See also Array.findLastIndex.
Parameters
- predicate: (value: T, index: number) => boolean
Returns number
Inherited from ReadonlyReactiveArray.findLastIndex
- Defined in collections/array.ts:131

flatMap

flatMap(
callback: (value: T, index: number) => U | readonly U[],
): ReactiveArray
Returns a new array where every item has been replaced with the result of calling the given callback function. If the callback function returns an array, the items in that array are included individually.

See also Array.flatMap.
Type Parameters
- U
Parameters
- callback: (value: T, index: number) => U | readonly U[]
Returns ReactiveArray
Inherited from ReadonlyReactiveArray.flatMap
- Defined in collections/array.ts:181

forEach

forEach(callback: (value: T, index: number) => void): void
Executes the given callback for every item in the array.

See also Array.forEach.
Parameters
- callback: (value: T, index: number) => void
Returns void
Inherited from ReadonlyReactiveArray.forEach
- Defined in collections/array.ts:152

get

get(index: number): T | undefined
Returns the item at the given index, or undefined if the index is out of bounds.
Parameters
- index: number
Returns T | undefined
Inherited from ReadonlyReactiveArray.get
- Defined in collections/array.ts:35

getItems

getItems(): T[]
Returns a new, non-reactive array with this array's current content.

Returns T[]
Inherited from ReadonlyReactiveArray.getItems
- Defined in collections/array.ts:22

includes

includes(value: T, fromIndex?: number): boolean
Searches for the given value and returns true if it was found, false otherwise.

See also Array.includes.
Parameters
- value: T
- OptionalfromIndex: number
Returns boolean
Inherited from ReadonlyReactiveArray.includes
- Defined in collections/array.ts:75

indexOf

indexOf(value: T, fromIndex?: number): number
Searches for the given value and returns its index, or -1 if it was not found.

See also Array.indexOf.
Parameters
- value: T
- OptionalfromIndex: number
Returns number
Inherited from ReadonlyReactiveArray.indexOf
- Defined in collections/array.ts:82

keys

keys(): IterableIterator<number>
Returns an iterator over the indices in this array.

Returns IterableIterator<number>
Inherited from ReadonlyReactiveArray.keys
- Defined in collections/array.ts:252

lastIndexOf

lastIndexOf(value: T): number
Searches backwards for the given value and returns its index, or -1 if it was not found.

See also Array.lastIndexOf.
Parameters
- value: T
Returns number
Inherited from ReadonlyReactiveArray.lastIndexOf
- Defined in collections/array.ts:89

map

map(callback: (value: T, index: number) => U): ReactiveArray
Returns a new array where every item has been replaced with the result of calling the given callback function.

See also Array.map.
Type Parameters
- U
Parameters
- callback: (value: T, index: number) => U
Returns ReactiveArray
Inherited from ReadonlyReactiveArray.map
- Defined in collections/array.ts:173

pop

pop(): T | undefined
Removes the last item from this array and returns it, or undefined if the array was empty.

See also Array.pop.

Returns T | undefined
- Defined in collections/array.ts:290

push

push(...values: T[]): void
Appends all given values to the end of this array.

See also Array.push.
Parameters
- ...values: T[]
Returns void
- Defined in collections/array.ts:283

reduce

reduce(
callback: (previousValue: T, currentValue: T, currentIndex: number) => T,
): T
Calls the given callback function for all items in this array. The return value of the previous callback invocation is passed in the next call. The final result of the callback will be returned from this function.

See also Array.reduce.
Parameters
- callback: (previousValue: T, currentValue: T, currentIndex: number) => T
Returns T
Inherited from ReadonlyReactiveArray.reduce
- Defined in collections/array.ts:190
reduce(
callback: (previousValue: T, currentValue: T, currentIndex: number) => T,
initialValue: T,
): T
Calls the given callback function for all items in this array. The return value of the previous callback invocation is passed in the next call. The final result of the callback will be returned from this function.

See also Array.reduce.
Parameters
- callback: (previousValue: T, currentValue: T, currentIndex: number) => T
- initialValue: T
Returns T
Inherited from ReadonlyReactiveArray.reduce
- Defined in collections/array.ts:199
reduce(
callback: (previousValue: U, currentValue: T, currentIndex: number) => U,
initialValue: U,
): U
Calls the given callback function for all items in this array. The return value of the previous callback invocation is passed in the next call. The final result of the callback will be returned from this function.

See also Array.reduce.
Type Parameters
- U
Parameters
- callback: (previousValue: U, currentValue: T, currentIndex: number) => U
- initialValue: U
Returns U
Inherited from ReadonlyReactiveArray.reduce
- Defined in collections/array.ts:211

reduceRight

reduceRight(
callback: (previousValue: T, currentValue: T, currentIndex: number) => T,
): T
Calls the given callback function for all items in this array, starting from the back. The return value of the previous callback invocation is passed in the next call. The final result of the callback will be returned from this function.

See also Array.reduceRight.
Parameters
- callback: (previousValue: T, currentValue: T, currentIndex: number) => T
Returns T
Inherited from ReadonlyReactiveArray.reduceRight
- Defined in collections/array.ts:223
reduceRight(
callback: (previousValue: T, currentValue: T, currentIndex: number) => T,
initialValue: T,
): T
Calls the given callback function for all items in this array, starting from the back. The return value of the previous callback invocation is passed in the next call. The final result of the callback will be returned from this function.

See also Array.reduceRight.
Parameters
- callback: (previousValue: T, currentValue: T, currentIndex: number) => T
- initialValue: T
Returns T
Inherited from ReadonlyReactiveArray.reduceRight
- Defined in collections/array.ts:232
reduceRight(
callback: (previousValue: U, currentValue: T, currentIndex: number) => U,
initialValue: U,
): U
Calls the given callback function for all items in this array, starting from the back. The return value of the previous callback invocation is passed in the next call. The final result of the callback will be returned from this function.

See also Array.reduceRight.
Type Parameters
- U
Parameters
- callback: (previousValue: U, currentValue: T, currentIndex: number) => U
- initialValue: U
Returns U
Inherited from ReadonlyReactiveArray.reduceRight
- Defined in collections/array.ts:244

set

set(index: number, value: T): void
Sets the item at the given index to value.
Parameters
- index: number
- value: T
Returns void
Inherited from ReadonlyReactiveArray.set
- Defined in collections/array.ts:40

shift

shift(): T | undefined
Removes the first value from this array and returns it, or undefined if the array was empty.

See also Array.shift.

Returns T | undefined
- Defined in collections/array.ts:304

slice

slice(start?: number): ReactiveArray<T>
Returns a shallow copy of this array.

See also Array.slice.
Parameters
- Optionalstart: number
Returns ReactiveArray<T>
Inherited from ReadonlyReactiveArray.slice
- Defined in collections/array.ts:47
slice(start: number, end?: number): ReactiveArray<T>
Returns a shallow copy of this array.

See also Array.slice.
Parameters
- start: number
- Optionalend: number
Returns ReactiveArray<T>
Inherited from ReadonlyReactiveArray.slice
- Defined in collections/array.ts:54

some

some(predicate: (value: T, index: number) => boolean): boolean
Returns true if at least one item satisfies the given predicate, false otherwise.

See also Array.some.
Parameters
- predicate: (value: T, index: number) => boolean
Returns boolean
Inherited from ReadonlyReactiveArray.some
- Defined in collections/array.ts:138

sort

sort(compare: (a: T, b: T) => number): void
Sorts this array using the given comparison function.

See also Array.sort.
Parameters
- compare: (a: T, b: T) => number
Returns void
- Defined in collections/array.ts:325

splice

splice(start: number, deleteCount?: number): T[]
Changes the contents of this array by removing, replacing and optionally adding new elements.

See also Array.splice.
Parameters
- start: number
- OptionaldeleteCount: number
Returns T[]
- Defined in collections/array.ts:311
splice(start: number, deleteCount: number, ...values: T[]): T[]
Changes the contents of this array by removing, replacing and optionally adding new elements.

See also Array.splice.
Parameters
- start: number
- deleteCount: number
- ...values: T[]
Returns T[]
- Defined in collections/array.ts:318

unshift

unshift(...values: T[]): void
Appends all given values to the beginning of this array.

See also Array.unshift.
Parameters
- ...values: T[]
Returns void
- Defined in collections/array.ts:297

values

values(): IterableIterator<T>
Returns an iterator over the items in this array.

Returns IterableIterator<T>
Inherited from ReadonlyReactiveArray.values
- Defined in collections/array.ts:257

Properties

`Readonly`length

length: number

Returns the current number of items in this array.

Interface ReactiveArray<T>

Type Parameters

Hierarchy (View Summary)

Index

Methods

Properties

Methods

at

Parameters

Returns T | undefined

concat

Parameters

Returns ReactiveArray<T>

Parameters

Returns ReactiveArray<T>

entries

Returns IterableIterator<[index: number, value: T]>

every

Parameters

Returns boolean

filter

Type Parameters

Parameters

Returns ReactiveArray<U>

Parameters

Returns ReactiveArray<T>

find

Type Parameters

Parameters

Returns U | undefined

Parameters

Returns T | undefined

findIndex

Parameters

Returns number

findLast

Type Parameters

Parameters

Returns U | undefined

Parameters

Returns T | undefined

findLastIndex

Parameters

Returns number

flatMap

Type Parameters

Parameters

Returns ReactiveArray<U>

forEach

Parameters

Returns void

get

Parameters

Returns T | undefined

getItems

Returns T[]

includes

Parameters

Returns boolean

indexOf

Parameters

Returns number

keys

Returns IterableIterator<number>

lastIndexOf

Parameters

Returns number

map

Type Parameters

Parameters

Returns ReactiveArray<U>

pop

Returns T | undefined

push

Parameters

Returns void

reduce

Parameters

Returns T

Parameters

`Readonly`length