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

Properties

batch? contentType? db docId document headers? signal?

Properties

Optionalbatch

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

OptionalcontentType

contentType?: string

The type of the input.

db

db: string

Path parameter to specify the database name.

docId

docId: string

Path parameter to specify the document ID.

document

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

HTTP request body for Document operations.

Optionalheaders

headers?: OutgoingHttpHeaders

Optionalsignal

signal?: GenericAbortSignal

Settings

Member Visibility

On This Page

Properties