SequenceDeltaEvent Class
The event object returned on sequenceDelta events.
The properties of this object and its sub-objects represent the state of the sequence at the point in time at which the operation was applied. They will not take into consideration any future modifications performed to the underlying sequence and merge tree.
For group ops, each op will get its own event, and the group op property will be set on the op args.
Ops may get multiple events. For instance, an insert-replace will get a remove then an insert event.
Signature
export declare class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType>
Extends: SequenceEvent<MergeTreeDeltaOperationType
Constructors
| Constructor | Description |
|---|---|
| (constructor)(opArgs, deltaArgs, mergeTreeClient) | Constructs a new instance of the SequenceDeltaEvent class |
Properties
| Property | Type | Description |
|---|---|---|
| isLocal | boolean | Whether the event was caused by a locally-made change. |
| opArgs | IMergeTreeDeltaOpArgs |
Constructor Details
(constructor)
Constructs a new instance of the SequenceDeltaEvent class
Signature
constructor(opArgs: IMergeTreeDeltaOpArgs, deltaArgs: IMergeTreeDeltaCallbackArgs, mergeTreeClient: Client);
Parameters
| Parameter | Type | Description |
|---|---|---|
| opArgs | IMergeTreeDeltaOpArgs | |
| deltaArgs | IMergeTreeDeltaCallbackArgs | |
| mergeTreeClient | Client |
Property Details
isLocal
Whether the event was caused by a locally-made change.
Signature
readonly isLocal: boolean;
Type: boolean
opArgs
Signature
readonly opArgs: IMergeTreeDeltaOpArgs;
Type: IMergeTreeDeltaOpArgs