diff --git a/types/pouchdb-core/index.d.ts b/types/pouchdb-core/index.d.ts index 4314644b58..decd2771fc 100644 --- a/types/pouchdb-core/index.d.ts +++ b/types/pouchdb-core/index.d.ts @@ -160,7 +160,8 @@ declare namespace PouchDB { _rev: RevisionId; } interface GetMeta { - /** Conflicting leaf revisions. + /** + * Conflicting leaf revisions. * * Only present if `GetOptions.conflicts` is `true` */ @@ -252,7 +253,8 @@ declare namespace PouchDB { }; interface AllDocsOptions extends Options { - /** Include attachment data for each document. + /** + * Include attachment data for each document. * * Requires `include_docs` to be `true`. * @@ -260,13 +262,15 @@ declare namespace PouchDB { * @see binary */ attachments?: boolean; - /** Return attachments as Buffers. + /** + * Return attachments as Buffers. * * Requires `include_docs` to be `true`. * Requires `attachments` to be `true`. */ binary?: boolean; - /** Include conflict information for each document. + /** + * Include conflict information for each document. * * Requires `include_docs` to be `true`. */ @@ -277,7 +281,8 @@ declare namespace PouchDB { include_docs?: boolean; /** Maximum number of documents to return. */ limit?: number; - /** Number of documents to skip before returning. + /** + * Number of documents to skip before returning. * * Causes poor performance on IndexedDB and LevelDB. */ @@ -296,7 +301,8 @@ declare namespace PouchDB { startkey: DocumentKey; /** High end of range, or low end if `descending` is `true`. */ endkey: DocumentKey; - /** Include any documents identified by `endkey`. + /** + * Include any documents identified by `endkey`. * * Defaults to `true`. */ @@ -443,7 +449,8 @@ declare namespace PouchDB { rev?: RevisionId; /** Include revision history of the document. */ revs?: boolean; - /** Include a list of revisions of the document, and their + /** + * Include a list of revisions of the document, and their * availability. */ revs_info?: boolean; @@ -459,7 +466,8 @@ declare namespace PouchDB { } interface GetOpenRevisions extends Options { - /** Fetch all leaf revisions if open_revs="all" or fetch all leaf + /** + * Fetch all leaf revisions if open_revs="all" or fetch all leaf * revisions specified in open_revs array. Leaves will be returned * in the same order as specified in input array. */ @@ -640,7 +648,8 @@ declare namespace PouchDB { options: Core.GetOpenRevisions ): Promise>>; - /** Create a new document without providing an id. + /** + * Create a new document without providing an id. * * You should prefer put() to post(), because when you post(), you are * missing an opportunity to use allDocs() to sort documents by _id @@ -652,7 +661,8 @@ declare namespace PouchDB { options: Core.Options | null, callback: Core.Callback): void; - /** Create a new document without providing an id. + /** + * Create a new document without providing an id. * * You should prefer put() to post(), because when you post(), you are * missing an opportunity to use allDocs() to sort documents by _id @@ -663,7 +673,8 @@ declare namespace PouchDB { post(doc: Core.PostDocument, options?: Core.Options): Promise; - /** Create a new document or update an existing document. + /** + * Create a new document or update an existing document. * * If the document already exists, you must specify its revision _rev, * otherwise a conflict will occur. @@ -675,7 +686,8 @@ declare namespace PouchDB { options: Core.Options | null, callback: Core.Callback): void; - /** Create a new document or update an existing document. + /** + * Create a new document or update an existing document. * * If the document already exists, you must specify its revision _rev, * otherwise a conflict will occur.