@couchbase/lite-js
    Preparing search index...

    Type Alias CBLDocument<D>

    CBLDocument: {} & D

    A Couchbase Lite document. Use Collection.getDocument to fetch a document or Collection.createDocument to create a new one.

    The Document can be used as if it were an object of the Collection's schema type (CBLDictionary by default).

    • Property values may be any JSON compatible type, as well as Blob.
    • Property names (at the top level) must not begin with an underscore. (This is a restriction imposed on the server by Sync Gateway / App Services.)

    The drawback is that Couchbase Lite can't reserve any properties for metadata like the DocID. To access that, call the function meta, which takes the document as its argument and returns a DocumentMeta object that exposes the metadata.

    Type Parameters