Type Alias InitOptions<T>

Options to be passed to init or load

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

Type Parameters

T
The type of the value the document contains

Index

Properties

actor? allowMissingChanges? author? freeze? patchCallback?

Properties

`Optional`actor

actor?: ActorId

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

`Optional`allowMissingChanges

allowMissingChanges?: boolean

Allow loading a document with missing changes

`Optional`author

author?: Author

The author for this document

`Optional`freeze

freeze?: boolean

`Optional`patchCallback

patchCallback?: PatchCallback<T>

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