Type alias InitOptions<T>

InitOptions<T>: {
    actor?: ActorId;
    allowMissingChanges?: boolean;
    freeze?: boolean;
    patchCallback?: PatchCallback<T>;
}

Options to be passed to init or load

Type Parameters

  • T

    The type of the value the document contains

Type declaration

  • Optional actor?: ActorId

    The actor ID to use for this document, a random one will be generated if null is passed

  • Optional allowMissingChanges?: boolean

    Allow loading a document with missing changes

  • Optional freeze?: boolean
  • Optional patchCallback?: PatchCallback<T>

    A callback which will be called with the initial patch once the document has finished loading

Generated using TypeDoc