Sign up (with export icon)

DocumentComparePatch

Api-interface iconinterface

The result of comparing a snapshot against processed data: the operations to bring the document to the new state, together with the snapshot metadata.

Can be applied via applyPatch.

Properties

  • Chevron-right icon

    channelId : string

    The channel of the document the snapshot was captured from, validated on apply.

  • Chevron-right icon

    operations : Record<string, Array<Operation>>

    The operations to apply, keyed by root name (a root with no changes maps to an empty array).

  • Chevron-right icon

    The options the patch was computed with, reused when applying it.

  • Chevron-right icon

    sessionId : string

    The editing session the snapshot was captured in, validated on apply.

  • Chevron-right icon

    version : number

    The snapshot version the operations are anchored to (used to reconcile them on apply).