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.

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.

Optionalrev

rev?: string

Query parameter to specify a document revision.

Settings

Member Visibility

On This Page

Properties