Interface GetSearchInfoParams

Parameters for the getSearchInfo operation.

interface GetSearchInfoParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    index: string;
    signal?: GenericAbortSignal;
}

Hierarchy

  • DefaultParams
    • GetSearchInfoParams

Properties

db ddoc headers? index signal?

Properties

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.

Optionalheaders

headers?: OutgoingHttpHeaders

index

index: string

Path parameter to specify the index name.

Optionalsignal

signal?: GenericAbortSignal

Settings

Member Visibility

On This Page

Properties