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

    Interface GetAttachmentParams

    Parameters for the getAttachment operation.

    interface GetAttachmentParams {
        accept?: string;
        attachmentName: string;
        db: string;
        docId: string;
        headers?: OutgoingHttpHeaders;
        ifMatch?: string;
        ifNoneMatch?: string;
        range?: string;
        rev?: string;
        signal?: GenericAbortSignal;
    }

    Hierarchy

    • DefaultParams
      • GetAttachmentParams
    Index

    Properties

    accept? attachmentName db docId headers? ifMatch? ifNoneMatch? range? rev? signal?

    Properties

    accept?: string

    The type of the response: /.

    attachmentName: string

    Path parameter to specify the attachment name.

    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.

    ifNoneMatch?: string

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

    range?: string

    Header parameter to specify the byte range for a request. This allows the implementation of resumable downloads and skippable streams. This is available for all attachments inside CouchDB.

    rev?: string

    Query parameter to specify a document revision.

    signal?: GenericAbortSignal

    Settings

    Member Visibility

    On This Page

    Properties