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

    Interface HeadDocumentParams

    Parameters for the headDocument operation.

    interface HeadDocumentParams {
        db: string;
        docId: string;
        headers?: OutgoingHttpHeaders;
        ifNoneMatch?: string;
        latest?: boolean;
        rev?: string;
        signal?: GenericAbortSignal;
    }

    Hierarchy

    • DefaultParams
      • HeadDocumentParams
    Index

    Properties

    db docId headers? ifNoneMatch? latest? rev? signal?

    Properties

    db: string

    Path parameter to specify the database name.

    docId: string

    Path parameter to specify the document ID.

    headers?: OutgoingHttpHeaders
    ifNoneMatch?: string

    Header parameter for a conditional HTTP request not matching an ETag.

    latest?: boolean

    Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.

    rev?: string

    Query parameter to specify a document revision.

    signal?: GenericAbortSignal

    Settings

    Member Visibility

    On This Page

    Properties