Interface PutLocalDocumentParams

Parameters for the putLocalDocument operation.

interface PutLocalDocumentParams {
    batch?: string;
    contentType?: string;
    db: string;
    docId: string;
    document: Buffer | ReadableStream | Document;
    headers?: OutgoingHttpHeaders;
}

Properties

batch? contentType? db docId document headers?

Properties

Optional batch

batch?: string

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

Optional contentType

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 | ReadableStream | Document

HTTP request body for Document operations.

Optional headers

headers?: OutgoingHttpHeaders

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc