Type alias BatchDeleteDescriptor

BatchDeleteDescriptor: {
    collection: string;
    id: string;
    op: "delete";
    parentId?: string;
}

A replace (DeleteItem) request to perform with [[batchReplaceDelete]].

Performs the equivalent operation as [[deleteById]]/[[deleteChildById][, which is a full delete on the primary key of a document

Type declaration

  • collection: string

    The root or child collection

  • id: string

    The item identifier

  • op: "delete"

    The operation to perform

  • Optional parentId?: string

    For child items, this is the parent object identifier (mandatory for root items, left blank for child items).

Settings

Member Visibility

Theme

Generated using TypeDoc