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

    Class Document

    Schema for a document.

    This type supports additional properties of type any.

    Indexable

    • [propName: string]: any

      Document accepts additional properties of type any.

    Index

    Constructors

    constructor

    Properties

    _attachments? _conflicts? _deleted? _deleted_conflicts? _id? _local_seq? _rev? _revisions? _revs_info?

    Methods

    deserialize serialize

    Constructors

    Properties

    Optional_attachments

    _attachments?: { [key: string]: CloudantV1.Attachment }

    Schema for a map of attachment name to attachment metadata.

    Optional_conflicts

    _conflicts?: string[]

    Schema for a list of document revision identifiers.

    Optional_deleted

    _deleted?: boolean

    Deletion flag. Available if document was removed.

    Optional_deleted_conflicts

    _deleted_conflicts?: string[]

    Schema for a list of document revision identifiers.

    Optional_id

    _id?: string

    Schema for a document ID.

    Optional_local_seq

    _local_seq?: string

    Document's update sequence in current database. Available if requested with local_seq=true query parameter.

    Optional_rev

    _rev?: string

    Schema for a document revision identifier.

    Optional_revisions

    _revisions?: CloudantV1.Revisions

    Schema for list of revision information.

    Optional_revs_info

    _revs_info?: CloudantV1.DocumentRevisionStatus[]

    Schema for a list of objects with information about local revisions and their status.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods