Skip to content 

SequenceDeltaEvent Class

Packages > @fluidframework/sequence > SequenceDeltaEvent

The event object returned on sequenceDelta events.

The properties of this object and its sub-objects represent a point in time state at the time the operation was applied. They will not take into any future modifications performed to the underlying sequence and merge tree.

For group ops, each op will get it’s own event, and the group op property will be set on the op args.

Ops may get multiple events. For instance, as insert-replace will get a remove then an insert event.

Signature:

export declare class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> 

Extends: SequenceEvent<MergeTreeDeltaOperationType>

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(opArgs, deltaArgs, mergeTreeClient) Constructs a new instance of the SequenceDeltaEvent class

Properties

List of properties for this class
Property Modifiers Type Description
isLocal boolean
opArgs IMergeTreeDeltaOpArgs

Constructors

SequenceDeltaEvent.(constructor)

Constructs a new instance of the SequenceDeltaEvent class

Signature:

constructor(opArgs: IMergeTreeDeltaOpArgs, deltaArgs: IMergeTreeDeltaCallbackArgs, mergeTreeClient: Client);

Parameters

List of parameters
Parameter Type Description
opArgs IMergeTreeDeltaOpArgs
deltaArgs IMergeTreeDeltaCallbackArgs
mergeTreeClient Client

Properties

isLocal

Signature:

readonly isLocal: boolean;

opArgs

Signature:

readonly opArgs: IMergeTreeDeltaOpArgs;