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

    Interface GetLocalDocumentParams

    Parameters for the getLocalDocument operation.

    interface GetLocalDocumentParams {
        accept?: string;
        attachments?: boolean;
        attEncodingInfo?: boolean;
        db: string;
        docId: string;
        headers?: OutgoingHttpHeaders;
        ifNoneMatch?: string;
        localSeq?: boolean;
        signal?: GenericAbortSignal;
    }

    Hierarchy

    • DefaultParams
      • GetLocalDocumentParams
    Index

    Properties

    accept? attachments? attEncodingInfo? db docId headers? ifNoneMatch? localSeq? signal?

    Properties

    accept?: string

    The type of the response: application/json, multipart/mixed, multipart/related, or application/octet-stream.

    attachments?: boolean

    Query parameter to specify whether to include attachment content in the response. Note that when used with a view-style query or changes feed this only applies when requesting documents in the response.

    attEncodingInfo?: boolean

    Query parameter to specify whether to include the encoding information for compressed attachments. Note that when used with a view-style query or changes feed this only applies when requesting documents in the response.

    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.

    localSeq?: boolean

    Query parameter to specify whether to include the last update sequence for the document.

    signal?: GenericAbortSignal

    Settings

    Member Visibility

    On This Page

    Properties