Interface DeleteLocalDocumentParams

Parameters for the deleteLocalDocument operation.

interface DeleteLocalDocumentParams {
    batch?: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    signal?: GenericAbortSignal;
}

Hierarchy

  • DefaultParams
    • DeleteLocalDocumentParams

Properties

batch? db docId headers? signal?

Properties

Optionalbatch

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

db

db: string

Path parameter to specify the database name.

docId

docId: string

Path parameter to specify the document ID.

Optionalheaders

headers?: OutgoingHttpHeaders

Optionalsignal

signal?: GenericAbortSignal

Settings

Member Visibility

On This Page

Properties