Skip to main content
Version: v1

EditLogSummary Interface

Information used to populate an edit log. In 0.1.1, this is a persisted type only for EditLogSummary<CompressedChangeInternal, FluidEditHandle>, where calling FluidEditHandle.get returns an array buffer of compressed editChunk contents. The type is parameterized to avoid nearly identical type definitions for uncompressed forms of the edit log, and abstracting away the fact that handle fetching needs to invoke decompression.

Signature​

export interface EditLogSummary<TChange, THandle>

Type Parameters​

Parameter Description
TChange
THandle

Properties​

Property Type Description
editChunks readonly { readonly startRevision: number; readonly chunk: THandle | readonly EditWithoutId<TChange>[]; }[] A of list of serialized chunks and their corresponding keys. Start revision is the index of the first edit in the chunk in relation to the edit log.
editIds readonly EditId[] A list of edits IDs for all sequenced edits.

Property Details​

editChunks​

A of list of serialized chunks and their corresponding keys. Start revision is the index of the first edit in the chunk in relation to the edit log.

Signature​

readonly editChunks: readonly {
        readonly startRevision: number;
        readonly chunk: THandle | readonly EditWithoutId<TChange>[];
    }[];

Type: readonly { readonly startRevision: number; readonly chunk: THandle | readonly EditWithoutId<TChange>[]; }[]

editIds​

A list of edits IDs for all sequenced edits.

Signature​

readonly editIds: readonly EditId[];

Type: readonly EditId[]