@ibm-cloud/cloudant - v0.12.7
    Preparing search index...

    Interface GetAllDbsParams

    Parameters for the getAllDbs operation.

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

    Hierarchy

    • DefaultParams
      • GetAllDbsParams
    Index

    Properties

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

    Properties

    descending?: boolean

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

    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.

    headers?: OutgoingHttpHeaders
    limit?: number

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

    signal?: GenericAbortSignal
    skip?: number

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

    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