Interface GetAllDbsParams

Parameters for the getAllDbs operation.

interface GetAllDbsParams {
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    limit?: number;
    skip?: number;
    startKey?: string;
}

Properties

descending? endKey? headers? limit? skip? startKey?

Properties

Optionaldescending

descending?: boolean

Query parameter to specify whether to return the documents in descending by key order.

OptionalendKey

endKey?: string

Query parameter to specify to stop returning records when the specified key is reached. String representation of any JSON type that matches the key type emitted by the view function.

Optionalheaders

headers?: OutgoingHttpHeaders

Optionallimit

limit?: number

Query parameter to specify the number of returned documents to limit the result to.

Optionalskip

skip?: number

Query parameter to specify the number of records before starting to return the results.

OptionalstartKey

startKey?: string

Query parameter to specify to start returning records from the specified key. String representation of any JSON type that matches the key type emitted by the view function.

Settings

Member Visibility

On This Page

Properties