SharedTreeDiagnosticEvent Enum
An event emitted by a SharedTree
for diagnostic purposes. See ISharedTreeEvents for event argument information.
Signature
export declare enum SharedTreeDiagnosticEvent
Flags
Flag | Description |
---|---|
AppliedEdit | A valid edit (local or remote) has been applied. Passed the EditId of the applied edit. Note that this may be called multiple times, due to concurrent edits causing reordering, and/or due to not caching the output of every edit. |
CatchUpBlobUploaded | A single catch up blob has been uploaded. |
DroppedInvalidEdit | An invalid edit (local or remote) has been dropped. Passed the EditId of the dropped edit. Note that this may be called multiple times, due to concurrent edits causing reordering, and/or due to not caching the output of every edit. |
DroppedMalformedEdit | A malformed edit (local or remote) has been dropped. Passed the EditId of the dropped edit. Note that this may be called multiple times, due to concurrent edits causing reordering, and/or due to not caching the output of every edit. |
EditChunkUploaded | An edit chunk blob has been uploaded. This includes catchup blobs. |
UnexpectedHistoryChunk | A history chunk has been received that does not have a corresponding edit chunk on the edit log. |
WriteVersionChanged | The current write format changed, either because an old summary was loaded or an update op was successfully processed. This event is emitted with the new version as an argument. |
AppliedEdit
A valid edit (local or remote) has been applied. Passed the EditId of the applied edit. Note that this may be called multiple times, due to concurrent edits causing reordering, and/or due to not caching the output of every edit.
Signature
AppliedEdit = "appliedEdit"
CatchUpBlobUploaded
A single catch up blob has been uploaded.
Signature
CatchUpBlobUploaded = "uploadedCatchUpBlob"
DroppedInvalidEdit
An invalid edit (local or remote) has been dropped. Passed the EditId of the dropped edit. Note that this may be called multiple times, due to concurrent edits causing reordering, and/or due to not caching the output of every edit.
Signature
DroppedInvalidEdit = "droppedInvalidEdit"
DroppedMalformedEdit
A malformed edit (local or remote) has been dropped. Passed the EditId of the dropped edit. Note that this may be called multiple times, due to concurrent edits causing reordering, and/or due to not caching the output of every edit.
Signature
DroppedMalformedEdit = "droppedMalformedEdit"
EditChunkUploaded
An edit chunk blob has been uploaded. This includes catchup blobs.
Signature
EditChunkUploaded = "uploadedEditChunk"
UnexpectedHistoryChunk
A history chunk has been received that does not have a corresponding edit chunk on the edit log.
Signature
UnexpectedHistoryChunk = "unexpectedHistoryChunk"
WriteVersionChanged
The current write format changed, either because an old summary was loaded or an update op was successfully processed. This event is emitted with the new version as an argument.
Signature
WriteVersionChanged = "writeVersionChanged"