Interface PutDesignDocumentParams

Parameters for the putDesignDocument operation.

interface PutDesignDocumentParams {
    batch?: string;
    db: string;
    ddoc: string;
    designDocument: DesignDocument;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    newEdits?: boolean;
    rev?: string;
}

Properties

batch? db ddoc designDocument headers? ifMatch? newEdits? rev?

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.

db

db: string

Path parameter to specify the database name.

ddoc

ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID excluding the _design/ prefix.

designDocument

designDocument: DesignDocument

HTTP request body for DesignDocument operations.

Optionalheaders

headers?: OutgoingHttpHeaders

OptionalifMatch

ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

OptionalnewEdits

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.

Optionalrev

rev?: string

Query parameter to specify a document revision.

Settings

Member Visibility

On This Page

Properties