Skip to main content
Version: v1

SequencedEditAppliedEventArguments Interface

The arguments included when the SequencedEditApplied SharedTreeEvent is emitted.

Signature

export interface SequencedEditAppliedEventArguments

Properties

Property Type Description
edit Edit<ChangeInternal> The ID of the edit committed.
logger ITelemetryLogger The telemetry logger associated with sequenced edit application.
outcome EditApplicationOutcome The outcome of the sequenced edit being applied.
reconciliationPath ReconciliationPath The reconciliation path for the edit. See ReconciliationPath for details.
tree SharedTree The tree the edit was applied to.
wasLocal boolean Whether or not this was a local edit.

Property Details

edit

The ID of the edit committed.

Signature

readonly edit: Edit<ChangeInternal>;

Type: Edit<ChangeInternal>

logger

The telemetry logger associated with sequenced edit application.

Signature

readonly logger: ITelemetryLogger;

Type: ITelemetryLogger

outcome

The outcome of the sequenced edit being applied.

Signature

readonly outcome: EditApplicationOutcome;

Type: EditApplicationOutcome

reconciliationPath

The reconciliation path for the edit. See ReconciliationPath for details.

Signature

readonly reconciliationPath: ReconciliationPath;

Type: ReconciliationPath

tree

The tree the edit was applied to.

Signature

readonly tree: SharedTree;

Type: SharedTree

wasLocal

Whether or not this was a local edit.

Signature

readonly wasLocal: boolean;

Type: boolean