Interface DeleteDocumentParams

Parameters for the deleteDocument operation.

interface DeleteDocumentParams {
    batch?: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

batch? db docId headers? ifMatch? rev?

Properties

Optional batch

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.

Optional headers

headers?: OutgoingHttpHeaders

Optional ifMatch

ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

Optional rev

rev?: string

Query parameter to specify a document revision.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc