SequenceDeltaEvent Interface

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.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/sequence/legacy.

For more information about our API support guarantees, see here.

Signature

export interface SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType>

Extends: SequenceEvent<MergeTreeDeltaOperationType>

Properties

Property	Alerts	Modifiers	Type	Description
isLocal	Beta	readonly	boolean	Whether the event was caused by a locally-made change.
opArgs	Beta	readonly	IMergeTreeDeltaOpArgs

Property Details

isLocal

Whether the event was caused by a locally-made change.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly isLocal: boolean;

Type: boolean

opArgs

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly opArgs: IMergeTreeDeltaOpArgs;

Type: IMergeTreeDeltaOpArgs