Interface ArrayMutator<T>

Mutates an array signal without exposing direct write access to the current snapshot.

interface ArrayMutator<T> {
    clear(): void;
    pop(): T | undefined;
    push(...items: T[]): number;
    replace(items: readonly T[]): void;
    set(index: number, value: T): T;
    shift(): T | undefined;
    splice(start: number, deleteCount?: number, ...items: T[]): T[];
    unshift(...items: T[]): number;
    update(index: number, update: (value: T) => T): T;
}

Type Parameters

Index

Methods

clear pop push replace set shift splice unshift update

Methods

clear

clear(): void
Removes all items from the array.

Returns void
- Defined in array.ts:82

pop

pop(): T | undefined
Removes the last item from the array.

Returns T | undefined
The removed item, if there was one.
- Defined in array.ts:25

push

push(...items: T[]): number
Appends items to the end of the array.
Parameters
- ...items: T[]
  The items to append.
Returns number
The new array length.
- Defined in array.ts:18

replace

replace(items: readonly T[]): void
Replaces the whole array content.
Parameters
- items: readonly T[]
  The new array content.
Returns void
- Defined in array.ts:77

set

set(index: number, value: T): T
Replaces the item at the given index.
Parameters
- index: number
  The index of the item to replace.
- value: T
  The new item value.
Returns T
The written value.

Throws
RangeError - When index is not a valid existing array index.
- Defined in array.ts:60

shift

shift(): T | undefined
Removes the first item from the array.

Returns T | undefined
The removed item, if there was one.
- Defined in array.ts:40

splice

splice(start: number, deleteCount?: number, ...items: T[]): T[]
Removes and optionally inserts items at the given position.
Parameters
- start: number
  The index at which to start changing the array.
- OptionaldeleteCount: number
  The number of items to remove.
- ...items: T[]
  The items to insert at start.
Returns T[]
The removed items.
- Defined in array.ts:50

unshift

unshift(...items: T[]): number
Prepends items to the beginning of the array.
Parameters
- ...items: T[]
  The items to prepend.
Returns number
The new array length.
- Defined in array.ts:33

update

update(index: number, update: (value: T) => T): T
Replaces the item at the given index with a value derived from the current item.
Parameters
- index: number
  The index of the item to replace.
- update: (value: T) => T
  Derives the new item value from the current one.
Returns T
The written value.

Throws
RangeError - When index is not a valid existing array index.
- Defined in array.ts:70

Interface ArrayMutator<T>

Type Parameters

Index

Methods

Methods

clear

Returns void

pop

Returns T | undefined

push

Parameters

Returns number

replace

Parameters

Returns void

set

Parameters

Returns T

Throws

shift

Returns T | undefined

splice

Parameters

Returns T[]

unshift

Parameters

Returns number

update

Parameters

Returns T

Throws

Settings

On This Page