Interface HeadDocumentParams

Parameters for the headDocument operation.

interface HeadDocumentParams {
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    rev?: string;
}

Properties

db docId headers? ifNoneMatch? latest? rev?

Properties

db

db: string

Path parameter to specify the database name.

docId

docId: string

Path parameter to specify the document ID.

Optional headers

headers?: OutgoingHttpHeaders

Optional ifNoneMatch

ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

Optional latest

latest?: boolean

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

Optional rev

rev?: string

Query parameter to specify a document revision.

Settings

Member Visibility

Theme

On This Page

dbdocIdheadersifNoneMatchlatestrev

Generated using TypeDoc