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

    Interface GetSchedulerDocsParams

    Parameters for the getSchedulerDocs operation.

    interface GetSchedulerDocsParams {
        headers?: OutgoingHttpHeaders;
        limit?: number;
        signal?: GenericAbortSignal;
        skip?: number;
        states?: string[] | States[];
    }

    Hierarchy

    • DefaultParams
      • GetSchedulerDocsParams
    Index

    Properties

    headers? limit? signal? skip? states?

    Properties

    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.

    states?: string[] | States[]

    Query parameter to include only replication documents in the specified states. String must be a comma-delimited string.

    Settings

    Member Visibility

    On This Page

    Properties