Type alias CollectionInsertOptions

CollectionInsertOptions: {
    overwriteMode?: "ignore" | "update" | "replace" | "conflict";
    returnNew?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}

Options for inserting a new document into a collection.

Type declaration

  • Optional overwriteMode?: "ignore" | "update" | "replace" | "conflict"

    Defines what should happen if a document with the same _key or _id already exists, instead of throwing an exception.

    Default: `"conflict"

  • Optional returnNew?: boolean

    If set to true, the complete new document will be returned as the new property on the result object. Has no effect if silent is set to true.

    Default: false

  • Optional silent?: boolean

    If set to true, no data will be returned by the server. This option can be used to reduce network traffic.

    Default: false

  • Optional waitForSync?: boolean

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

    Default: false

Settings

Theme

Generated using TypeDoc