Type alias GraphCollectionReplaceOptions

GraphCollectionReplaceOptions: {
    keepNull?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}

Options for replacing a document in a graph collection.

Type declaration

  • Optional keepNull?: boolean

    If set to false, properties with a value of null will be removed from the new document.

    Default: true

  • Optional returnNew?: boolean

    If set to true, the complete new document will be returned as the new property on the result object.

    Default: false

  • Optional returnOld?: boolean

    If set to true, the complete old document will be returned as the old property on the result object.

    Default: false

  • Optional rev?: string

    If set to a document revision, the document will only be modified if its _rev property matches this value.

    See also DocumentMetadata.

  • Optional waitForSync?: boolean

    If set to true, data will be synchronized to disk before returning.

    Default: false

Settings

Theme

Generated using TypeDoc