@ibm-cloud/cloudant - v0.12.3
    Preparing search index...

    Interface DeleteDocumentParams

    Parameters for the deleteDocument operation.

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

    Hierarchy

    • DefaultParams
      • DeleteDocumentParams
    Index

    Properties

    batch? db docId headers? ifMatch? rev? signal?

    Properties

    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: string

    Path parameter to specify the database name.

    docId: string

    Path parameter to specify the document ID.

    headers?: OutgoingHttpHeaders
    ifMatch?: string

    Header parameter for a conditional HTTP request matching an ETag.

    rev?: string

    Query parameter to specify a document revision.

    signal?: GenericAbortSignal

    Settings

    Member Visibility

    On This Page

    Properties