kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-04-20 21:12:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

pouchdb-core: Fix lint (#20908)

Browse Source
This commit is contained in:
Andy
2017-10-23 13:20:10 -07:00
committed by GitHub
parent 37748ebb29
commit 4d69fe816c
1 changed files with 24 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
types/pouchdb-core/index.d.ts vendored
View File

@@ -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<Array<Core.Revision<Content & Model>>>;
/** 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<Core.Response>): 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<Model>(doc: Core.PostDocument<Content & Model>,
options?: Core.Options): Promise<Core.Response>;
/** 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<Core.Response>): 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.