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

    Interface PutDocumentParams

    Parameters for the putDocument operation.

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

    Hierarchy

    • DefaultParams
      • PutDocumentParams
    Index

    Properties

    batch? contentType? db docId document headers? ifMatch? newEdits? rev? 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
    ifMatch?: string

    Header parameter for a conditional HTTP request matching an ETag.

    newEdits?: boolean

    Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a well-formed _rev must be included in the document. False is used by the replicator to insert documents into the target database even if that leads to the creation of conflicts.

    Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it is very easy to accidentally end up with a large number of conflicts.

    rev?: string

    Query parameter to specify a document revision.

    signal?: GenericAbortSignal

    Settings

    Member Visibility

    On This Page

    Properties