The key type.
The value type.
Constructs a MultiValueMap.
Aggregator.wallClockTime and Aggregator.lamportTimestamp are used as settings for our [[MultiValueMapItems]]. Aggregator.aggregate is ignored.
Serializer for keys. Defaults to [[DefaultSerializer]].
Serializer for values. Defaults to [[DefaultSerializer]].
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]].
Internal (parent) use only.
If this Collab is in its initial, post-constructor state, then this method may (but is not required to) return true; otherwise, it returns false.
By default, this method always returns false; override to change.
If this method returns true:
load(null, meta).
load should process this as if called with the output of save
from a garbage-collectable state. For a nontrivial example,
see CMultiValueMap.load's implementation.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.
Returns an iterable of [key, get(key)] pairs
for every entry in the map.
The iteration order is NOT eventually consistent: it may differ on replicas with the same state.
Internal (parent) use only.
Called by this Collab's parent when it has been deleted from a collection on the local replica and can no longer be used (e.g., due to CSet.delete on this or an ancestor). A Collab implementation can implement this method to clean up external resources, e.g., associated DOM elements.
finalize has no relation to the JavaScript garbage collector or
canGC.
By default, this method does nothing.
Returns the array of MultiValueMapItems corresponding
to conflicting concurrent sets at key,
or undefined if key is not present.
If defined, the return value is always non-empty, and its order is eventually consistent. Specifically, it is in order by [[MultiValueMapItem.sender]].
Called by this Collab's parent to load some saved state. You may assume that the saved state was generated by saveCRDT on some replica of this Collab, possibly in a different collaboration session, with guarantees set by the runtime.
This method may also be called with savedState = null;
you should ignore such calls (i.e., return immediately)
unless you override canGC. If you do override canGC,
see that method's docs for instructions.
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.
Receives a message sent by sendCRDT on a local or remote replica of this PrimitiveCRDT.
This method processes the message, changes the local state accordingly, and emits events describing the local changes.
This method may assume eventual, exactly-once, causal-order message delivery, and it must ensure strong eventual consistency.
See [[Collab.receive]].
Do not override; override receiveCRDT instead.
Returns saved state describing the current state of this Collab.
The saved state may later be passed to loadCRDT on a replica of this Collab, possibly in a different collaboration session, with rules set by the runtime. For example, CRuntime allows load to be called only at the beginning of a session, before sending or receiving any messages.
saveCRDT may be called at any time, possibly many times while an app
is running. Calling saveCRDT should not affect this Collab's
user-visible state.
The saved state.
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.
Broadcasts a message to other replicas of this CRDT. The message will be delivered to all replicas' receiveCRDT, including locally.
Call this method instead of [[Collab.send]] or [[CPrimitive.sendPrimitive]].
By default, receiveCRDT's crdtMeta will contain all fields that are accessed
during the sender's local call to receiveCRDT.
You can request additional fields with metaRequest.
The message to send.
Broadcasts a message to other replicas of this Collab. The message will be delivered to all replicas' receivePrimitive, including locally.
Call this method instead of [[Collab.send]].
The message to send.
A metadata request. The runtime will use this when creating the [[MessageMeta]] for receivePrimitive.
Sets the value at key.
The corresponding MultiValueMapItem.
Generated using TypeDoc
A collaborative "multi-value" map, in which there may be multiple values for a key due to concurrent set operations.
This is a low-level API intended for internal use by other CRDT implementations. In most apps, you are better off using CValueMap or CMap.