Interface GetDesignDocumentParams

Parameters for the getDesignDocument operation.

interface GetDesignDocumentParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    deletedConflicts?: boolean;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attachments? attEncodingInfo? conflicts? db ddoc deletedConflicts? headers? ifNoneMatch? latest? localSeq? meta? rev? revs? revsInfo?

Properties

Optionalattachments

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

OptionalattEncodingInfo

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is compressed.

Optionalconflicts

conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when include_docs is true.

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.

OptionaldeletedConflicts

deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the _deleted_conflicts property of the returned document.

Optionalheaders

headers?: OutgoingHttpHeaders

OptionalifNoneMatch

ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

Optionallatest

latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.

OptionallocalSeq

localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

Optionalmeta

meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of the conflicts, deleted_conflicts and open_revs query parameters.

Optionalrev

rev?: string

Query parameter to specify a document revision.

Optionalrevs

revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

OptionalrevsInfo

revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

Settings

Member Visibility

On This Page

Properties