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

    Interface PostDesignDocsParams

    Parameters for the postDesignDocs operation.

    interface PostDesignDocsParams {
        attachments?: boolean;
        attEncodingInfo?: boolean;
        conflicts?: boolean;
        db: string;
        descending?: boolean;
        endKey?: string;
        headers?: OutgoingHttpHeaders;
        includeDocs?: boolean;
        inclusiveEnd?: boolean;
        key?: string;
        keys?: string[];
        limit?: number;
        signal?: GenericAbortSignal;
        skip?: number;
        startKey?: string;
        updateSeq?: boolean;
    }

    Hierarchy

    • DefaultParams
      • PostDesignDocsParams
    Index

    Properties

    attachments? attEncodingInfo? conflicts? db descending? endKey? headers? includeDocs? inclusiveEnd? key? keys? limit? signal? skip? startKey? updateSeq?

    Properties

    attachments?: boolean

    Parameter to specify whether to include attachments bodies in a response.

    attEncodingInfo?: boolean

    Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is compressed.

    conflicts?: boolean

    Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when include_docs is true.

    db: string

    Path parameter to specify the database name.

    descending?: boolean

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

    endKey?: string

    Schema for a document ID.

    headers?: OutgoingHttpHeaders
    includeDocs?: boolean

    Parameter to specify whether to include the full content of the documents in the response.

    inclusiveEnd?: boolean

    Parameter to specify whether the specified end key should be included in the result.

    key?: string

    Schema for a document ID.

    keys?: string[]

    Schema for a list of document IDs.

    limit?: number

    Parameter to specify the number of returned documents to limit the result to.

    signal?: GenericAbortSignal
    skip?: number

    Parameter to specify the number of records before starting to return the results.

    startKey?: string

    Schema for a document ID.

    updateSeq?: boolean

    Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the database the view reflects.

    Settings

    Member Visibility

    On This Page

    Properties