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

    Interface PutAttachmentParams

    Parameters for the putAttachment operation.

    interface PutAttachmentParams {
        attachment: Buffer<ArrayBufferLike> | ReadableStream;
        attachmentName: string;
        contentType: string;
        db: string;
        docId: string;
        headers?: OutgoingHttpHeaders;
        ifMatch?: string;
        rev?: string;
        signal?: GenericAbortSignal;
    }

    Hierarchy

    • DefaultParams
      • PutAttachmentParams
    Index

    Properties

    attachment attachmentName contentType db docId headers? ifMatch? rev? signal?

    Properties

    attachment: Buffer<ArrayBufferLike> | ReadableStream

    HTTP request body for attachment operations.

    attachmentName: string

    Path parameter to specify the attachment name.

    contentType: string

    Content-Type of the attachment.

    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