The value type.
Constructs a CValueList.
Serializer
for an array of values, used for bulk operations and saved states.
Defaults to using valueSerializer on each value.
Serializer for values. Defaults to [[DefaultSerializer]].
The children (registered Collab properties), keyed by name.
This map should only be read, not mutated. It is exposed to subclasses as a convenience for methods that loop over all children.
Internal (this/parent) use only.
This Collab's name, which distinguishes it among its siblings in the tree of Collabs.
Internal (this/parent) use only.
This Collab's parent in the tree of Collabs.
The ambient [[IRuntime]].
Use this to access utilities like [[IRuntime.replicaID]].
The abstract total order underlying this list CRDT.
Access this to construct separate LocalList views on top of the same total order.
Internal (parent) use only.
By default, this method returns true if canGC returns true
on every child. Override to change this behavior.
See [[Collab.canGC]].
Emits an event, which triggers all the registered event handlers.
See [[CollabEventsRecord]] for advice on what events to emit.
This is a wrapper around [[EventEmitter.emit]] that forces events to extend [[CollabEvent]] and also emits an "Any" event.
Set to true to skip emitting an "Any" event.
Internal (parent) use only.
By default, this methods calls finalize on every child.
Override to change this behavior,
e.g., to add your own finalization steps
(but consider calling super.finalize()).
Inserts values at the given index.
All values currently at or after index shift
to the right, increasing their indices by values.length.
The insertion index in the range
[0, this.length]. If this.length, the values
are appended to the end of the list.
The first inserted value, or undefined if there are no values.
Registers an event handler that is triggered when the event happens.
Name of the event to listen on.
Callback that handles the event.
If true, the event handler is triggered at most once (the next time the event happens), then unsubscribed.
An "off" function that removes the event handler when called.
Registers an event handler that is triggered when the event happens.
An "off" function that removes the event handler when called.
Inserts values at the end of the list.
Equivalent to this.insert(this.length, ...values).
Registers a [[Collab]] property of this CObject with the given name, making it one of our children.
Typically, you will call this method during the constructor in the style:
this.foo = this.registerCollab("foo", (init) => new FooClass(init, constructor args...));
where readonly foo: FooClass; is a Collab property. See
Data Modeling
for examples.
Registrations must be identical across all replicas.
See also: CRuntime.registerCollab.
A name for this property, unique among
this class's registerCollab calls.
We recommend using the same name as the property,
but you can also use short strings to reduce
network usage ("", "0", "1", ...).
A callback that uses the given [[InitToken]] to construct the registered [[Collab]].
The registered Collab.
Broadcasts a message to other replicas of this Collab. The message will be delivered to all replicas' receive, including locally.
For convenience, the message may be expressed as a stack of
(Uint8Array | string),
instead of just a single Uint8Array. This is
useful for parents sending messages on behalf of their children;
see the implementation of [[CObject]] for an example.
The message to send, in the form of a stack of Uint8Arrays. Note that this method may mutate it in-place.
Deletes and inserts values like Array.splice.
If deleteCount is provided, this method first deletes
deleteCount values starting at start.
Next, this method inserts values at start.
All values currently at or after start + deleteCount
shift to accommodate the change in length.
The deleted values.
Inserts values at the beginning of the list.
Equivalent to this.insert(0, ...values).
Generated using TypeDoc
A collaborative list with values of type T.
CValueList<T>has a similar API toArray<T>, but it is mutated more like a linked list: instead of mutating existing values, you insert and delete list entries. Insertions and deletions shift later entries, changing their indices, like in collaborative text editing or Array.splice.Values must be internally immutable; mutating a value internally will not change it on other replicas. If you need to mutate values internally, instead use a CList.
It is not safe to modify a CValueList while iterating over it. The iterator will attempt to throw an exception if it detects such modification, but this is not guaranteed.
See also: CList, CText, CRichText.