mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
f0ce987bc1
Note that this *trivially* updates project urls by adding the NPM url to the end, even when the urls are almost identical or the DT one is outdated. I'll clean up the urls in a later commit. This PR is unfinished! Please do not merge it yet.
78 lines
3.5 KiB
TypeScript
78 lines
3.5 KiB
TypeScript
// Type definitions for pouchdb-upsert 2.2
|
|
// Project: https://github.com/pouchdb/upsert, https://github.com/nolanlawson/pouchdb-upsert
|
|
// Definitions by: Keith D. Moore <https://github.com/keithdmoore>
|
|
// Andrew Mitchell <https://github.com/hotforfeature>
|
|
// Eddie Hsu <https://github.com/apolkingg8>
|
|
// John McLaughlin <https://github.com/zamb3zi>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.4
|
|
|
|
/// <reference types="pouchdb-core" />
|
|
|
|
declare namespace PouchDB {
|
|
interface Database<Content extends {} = {}> {
|
|
/**
|
|
* Perform an upsert (update or insert) operation. Returns a Promise.
|
|
*
|
|
* @param docId - the _id of the document.
|
|
* @param diffFun - function that takes the existing doc as input and returns an updated doc.
|
|
* If this diffFunc returns falsey, then the update won't be performed (as an optimization).
|
|
* If the document does not already exist, then {} will be the input to diffFunc.
|
|
*
|
|
*/
|
|
upsert<Model>(docId: Core.DocumentId, diffFun: UpsertDiffCallback<Content & Model>): Promise<UpsertResponse>;
|
|
|
|
/**
|
|
* Perform an upsert (update or insert) operation. If a callback is not provided, the Promise based version
|
|
* of this function will be called.
|
|
*
|
|
* @param docId - the _id of the document.
|
|
* @param diffFun - function that takes the existing doc as input and returns an updated doc.
|
|
* If this diffFunc returns falsey, then the update won't be performed (as an optimization).
|
|
* If the document does not already exist, then {} will be the input to diffFunc.
|
|
* @param callback - called with the results after operation is completed.
|
|
*/
|
|
upsert<Model>(docId: Core.DocumentId, diffFun: UpsertDiffCallback<Content & Model>,
|
|
callback: Core.Callback<UpsertResponse>): void;
|
|
|
|
/**
|
|
* Put a new document with the given docId, if it doesn't already exist. Returns a Promise.
|
|
*
|
|
* @param doc - the document to insert. Should contain an _id if docId is not specified
|
|
* If the document already exists, then the Promise will just resolve immediately.
|
|
*/
|
|
putIfNotExists<Model>(doc: Core.Document<Content & Model>): Promise<UpsertResponse>;
|
|
|
|
//
|
|
/**
|
|
* Put a new document with the given docId, if it doesn't already exist. If a callback is not provided,
|
|
* the Promise based version of this function will be called.
|
|
*
|
|
* @param doc - the document to insert. Should contain an _id if docId is not specified
|
|
* If the document already exists, then the Promise will just resolve immediately.
|
|
* @param callback - called with the results after operation is completed.
|
|
* If you don't specify a callback, then the Promise version of this function will be invoked and it
|
|
* will return a Promise.
|
|
*/
|
|
putIfNotExists<Model>(doc: Core.Document<Content & Model>,
|
|
callback: Core.Callback<UpsertResponse>): void;
|
|
}
|
|
|
|
type CancelUpsert = '' | 0 | false | null | undefined; // falsey values
|
|
// `Partial<Core.Document<Content>>` seems more useful than
|
|
// `{} | Core.Document<Content>` since there isn't an easy way to narrow
|
|
// `{} | Core.Document<Content>` to `Core.Document<Content>`.
|
|
type UpsertDiffCallback<Content extends {}> = (doc: Partial<Core.Document<Content>>) => Content & Partial<Core.IdMeta> | CancelUpsert;
|
|
|
|
interface UpsertResponse {
|
|
id: Core.DocumentId;
|
|
rev: Core.RevisionId;
|
|
updated: boolean;
|
|
}
|
|
}
|
|
|
|
declare module 'pouchdb-upsert' {
|
|
const plugin: PouchDB.Plugin;
|
|
export = plugin;
|
|
}
|