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

    Interface PutLocalDocumentParams

    Parameters for the putLocalDocument operation.

    interface PutLocalDocumentParams {
        batch?: string;
        contentType?: string;
        db: string;
        docId: string;
        document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document;
        headers?: OutgoingHttpHeaders;
        signal?: GenericAbortSignal;
    }

    Hierarchy

    • DefaultParams
      • PutLocalDocumentParams
    Index

    Properties

    batch? contentType? db docId document headers? 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.

    contentType?: string

    The type of the input.

    db: string

    Path parameter to specify the database name.

    docId: string

    Path parameter to specify the document ID.

    document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document

    HTTP request body for Document operations.

    headers?: OutgoingHttpHeaders
    signal?: GenericAbortSignal

    Settings

    Member Visibility

    On This Page

    Properties