Class CRList<T>

A convergent replicated list.

Iteration, find(), some(), and forEach() expose the same live value references. Mutating returned objects directly can mutate replica state without producing a CRDT delta, so callers must isolate values before out-of-band mutation. Local mutations emit delta and change events; remote merges emit change events.

Type Parameters

T
The value type stored in the list.

Index

Constructors

constructor

new CRList<T>(snapshot?: CRListSnapshot<T>): CRList<T>
Creates a replicated list from an optional CRList snapshot.
Type Parameters
- T
  The value type stored in the list.
Parameters
- Optionalsnapshot: CRListSnapshot<T>
  A previously emitted CRList snapshot.
Returns CRList<T>
- Defined in src/CRList/class.ts:45

Accessors

size

get size(): number
The current number of live entries.

Returns number
- Defined in src/CRList/class.ts:75

Methods

[iterator]

"[iterator]"(): IterableIterator<T>
Iterates over current live values in index order.

Returns IterableIterator<T>
- Defined in src/CRList/class.ts:370

acknowledge

acknowledge(): void
Emits an acknowledgement frontier for currently retained deleted item ids.

Returns void
- Defined in src/CRList/class.ts:264

addEventListener

addEventListener<K extends keyof CRListEventMap<T>>(
    type: K,
    listener: CRListEventListenerFor<T, K> | null,
    options?: boolean | AddEventListenerOptions,
): void
Registers an event listener.
Type Parameters
- K extends keyof CRListEventMap<T>
Parameters
- type: K
  The event type to listen for.
- listener: CRListEventListenerFor<T, K> | null
  The listener to register.
- Optionaloptions: boolean | AddEventListenerOptions
  Listener registration options.
Returns void
- Defined in src/CRList/class.ts:297

append

append(values: T[], afterIndex?: number): void
Inserts values after an index.

If afterIndex is omitted, values are appended at the end of the list.
Parameters
- values: T[]
  Values to insert.
- OptionalafterIndex: number
  The index to insert after.
Returns void
- Defined in src/CRList/class.ts:146

delete

delete(index: number, count?: number): void
Removes one or more entries starting at an index.
Parameters
- index: number
  The first index to remove.
- count: number = 1
  Number of entries to remove. Defaults to 1.
Returns void
- Defined in src/CRList/class.ts:174

find

find(
    predicate: (
        this: unknown,
        value: T,
        index: number,
        list: this,
    ) => unknown,
    thisArg?: unknown,
): T | undefined
Returns the first live value matching a predicate in index order.

Predicate values are live references. Mutating them directly can mutate the list without emitting a delta.
Parameters
- predicate: (this: unknown, value: T, index: number, list: this) => unknown
  Function to test each live value.
- OptionalthisArg: unknown
  Optional this value for the predicate.
Returns T | undefined
- Defined in src/CRList/class.ts:200

forEach

forEach(
callback: (value: T, index: number, list: this) => void,
thisArg?: unknown,
): void
Calls a function once for each live value in index order.

Callback values are live references. Mutating them directly can mutate the list without emitting a delta.
Parameters
- callback: (value: T, index: number, list: this) => void
  Function to call for each live value.
- OptionalthisArg: unknown
  Optional this value for the callback.
Returns void
- Defined in src/CRList/class.ts:384

garbageCollect

garbageCollect(frontiers: (readonly [number, number, number, number])[]): void
Garbage-collects deleted item ids covered by acknowledgement frontiers.
Parameters
- frontiers: (readonly [number, number, number, number])[]
  Replica acknowledgement frontiers.
Returns void
- Defined in src/CRList/class.ts:276

get

get(index: number): T | undefined
Reads an item in the live list projection by index.

Returns a live value reference.
Parameters
- index: number
  The index to read.
Returns T | undefined
- Defined in src/CRList/class.ts:87

merge

merge(delta: CRListDelta<T>): void
Applies a remote gossip delta to this list.

Emits a change event when the merge changes the live projection.
Parameters
- delta: CRListDelta<T>
  The remote CRList delta to merge.
Returns void
- Defined in src/CRList/class.ts:250

prepend

prepend(values: T[], beforeIndex?: number): void
Inserts values before an index.

If beforeIndex is omitted, values are inserted at the start of the list.
Parameters
- values: T[]
  Values to insert.
- OptionalbeforeIndex: number
  The index to insert before.
Returns void
- Defined in src/CRList/class.ts:122

removeEventListener

removeEventListener<K extends keyof CRListEventMap<T>>(
    type: K,
    listener: CRListEventListenerFor<T, K> | null,
    options?: boolean | EventListenerOptions,
): void
Removes an event listener.
Type Parameters
- K extends keyof CRListEventMap<T>
Parameters
- type: K
  The event type to stop listening for.
- listener: CRListEventListenerFor<T, K> | null
  The listener to remove.
- Optionaloptions: boolean | EventListenerOptions
  Listener removal options.
Returns void
- Defined in src/CRList/class.ts:320

set

set(index: number, values: T[]): void
Overwrites entries starting at an index.
Parameters
- index: number
  The index to start overwriting at.
- values: T[]
  Values to write.
Returns void
- Defined in src/CRList/class.ts:97

snapshot

snapshot(): void
Emits the current CRList snapshot.

Snapshot value payloads are live references. Mutating them can mutate replica state without emitting a delta.

Returns void
- Defined in src/CRList/class.ts:286

some

some(
    predicate: (
        this: unknown,
        value: T,
        index: number,
        list: this,
    ) => unknown,
    thisArg?: unknown,
): boolean
Tests whether any live value matches a predicate in index order.

Predicate values are live references. Mutating them directly can mutate the list without emitting a delta.
Parameters
- predicate: (this: unknown, value: T, index: number, list: this) => unknown
  Function to test each live value.
- OptionalthisArg: unknown
  Optional this value for the predicate.
Returns boolean
- Defined in src/CRList/class.ts:226

toJSON

toJSON(): CRListSnapshot<T>
Returns a CRList snapshot of this list.

Snapshot value payloads are live references. Mutating them can mutate replica state without emitting a delta.

Called automatically by JSON.stringify.

Returns CRListSnapshot<T>
- Defined in src/CRList/class.ts:340

toString

toString(): string
Attempts to return this list snapshot as a JSON string.

This can fail when list values are not JSON-compatible.

Returns string
- Defined in src/CRList/class.ts:349

Class CRList<T>

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CRList<T>

Accessors

size

Returns number

Methods

[iterator]

Returns IterableIterator<T>

acknowledge

Returns void

addEventListener

Type Parameters

Parameters

Returns void

append

Parameters

Returns void

delete

Parameters

Returns void

find

Parameters

Returns T | undefined

forEach

Parameters

Returns void

garbageCollect

Parameters

Returns void

get

Parameters

Returns T | undefined

merge

Parameters

Returns void

prepend

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

set

Parameters

Returns void

snapshot

Returns void

some

Parameters

Returns boolean

toJSON

Returns CRListSnapshot<T>

toString

Returns string

Settings

On This Page