Type alias ChangeOptions<T>

ChangeOptions<T>: {
    message?: string;
    patchCallback?: PatchCallback<T>;
    time?: number;
}

Options passed to change, and emptyChange

Type Parameters

  • T

    The type of value contained in the document

Type declaration

  • Optional message?: string

    A message which describes the changes

  • Optional patchCallback?: PatchCallback<T>

    A callback which will be called to notify the caller of any changes to the document

  • Optional time?: number

    The unix timestamp (in seconds) of the change (purely advisory, not used in conflict resolution). When omitted it defaults to the current timestamp. When set to undefined no timestamp is used.

Generated using TypeDoc