Skip to content

Commit

Permalink
fix(index.d.ts): support legacy 2nd param callback syntax for `delete…
Browse files Browse the repository at this point in the history
…One()`, `deleteMany()`

Fix #10122
  • Loading branch information
vkarpov15 committed Apr 16, 2021
1 parent c90140f commit e2b7553
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -443,11 +443,13 @@ declare module 'mongoose' {

/** Removes this document from the db. */
delete(options?: QueryOptions): QueryWithHelpers<any, this, TQueryHelpers>;
delete(options?: QueryOptions, cb?: (err: CallbackError, res: any) => void): void;
delete(options: QueryOptions, cb?: (err: CallbackError, res: any) => void): void;
delete(cb: (err: CallbackError, res: any) => void): void;

/** Removes this document from the db. */
deleteOne(options?: QueryOptions): QueryWithHelpers<any, this, TQueryHelpers>;
deleteOne(options?: QueryOptions, cb?: (err: CallbackError, res: any) => void): void;
deleteOne(options: QueryOptions, cb?: (err: CallbackError, res: any) => void): void;
deleteOne(cb: (err: CallbackError, res: any) => void): void;

/** Takes a populated field and returns it to its unpopulated state. */
depopulate(path: string): this;
Expand Down Expand Up @@ -679,13 +681,17 @@ declare module 'mongoose' {
* regardless of the `single` option.
*/
deleteMany(filter?: FilterQuery<T>, options?: QueryOptions, callback?: (err: CallbackError) => void): QueryWithHelpers<mongodb.DeleteWriteOpResultObject['result'] & { deletedCount?: number }, T, TQueryHelpers>;
deleteMany(filter: FilterQuery<T>, callback: (err: CallbackError) => void): QueryWithHelpers<mongodb.DeleteWriteOpResultObject['result'] & { deletedCount?: number }, T, TQueryHelpers>;
deleteMany(callback: (err: CallbackError) => void): QueryWithHelpers<mongodb.DeleteWriteOpResultObject['result'] & { deletedCount?: number }, T, TQueryHelpers>;

/**
* Deletes the first document that matches `conditions` from the collection.
* Behaves like `remove()`, but deletes at most one document regardless of the
* `single` option.
*/
deleteOne(filter?: FilterQuery<T>, options?: QueryOptions, callback?: (err: CallbackError) => void): QueryWithHelpers<mongodb.DeleteWriteOpResultObject['result'] & { deletedCount?: number }, T, TQueryHelpers>;
deleteOne(filter: FilterQuery<T>, callback: (err: CallbackError) => void): QueryWithHelpers<mongodb.DeleteWriteOpResultObject['result'] & { deletedCount?: number }, T, TQueryHelpers>;
deleteOne(callback: (err: CallbackError) => void): QueryWithHelpers<mongodb.DeleteWriteOpResultObject['result'] & { deletedCount?: number }, T, TQueryHelpers>;

/**
* Sends `createIndex` commands to mongo for each index declared in the schema.
Expand Down Expand Up @@ -1926,13 +1932,17 @@ declare module 'mongoose' {
* collection, regardless of the value of `single`.
*/
deleteMany(filter?: FilterQuery<DocType>, options?: QueryOptions, callback?: (err: CallbackError, res: any) => void): QueryWithHelpers<any, DocType, THelpers>;
deleteMany(filter: FilterQuery<DocType>, callback: (err: CallbackError, res: any) => void): QueryWithHelpers<any, DocType, THelpers>;
deleteMany(callback: (err: CallbackError, res: any) => void): QueryWithHelpers<any, DocType, THelpers>;

/**
* Declare and/or execute this query as a `deleteOne()` operation. Works like
* remove, except it deletes at most one document regardless of the `single`
* option.
*/
deleteOne(filter?: FilterQuery<DocType>, options?: QueryOptions, callback?: (err: CallbackError, res: any) => void): QueryWithHelpers<any, DocType, THelpers>;
deleteOne(filter: FilterQuery<DocType>, callback: (err: CallbackError, res: any) => void): QueryWithHelpers<any, DocType, THelpers>;
deleteOne(callback: (err: CallbackError, res: any) => void): QueryWithHelpers<any, DocType, THelpers>;

/** Creates a `distinct` query: returns the distinct values of the given `field` that match `filter`. */
distinct(field: string, filter?: FilterQuery<DocType>, callback?: (err: any, count: number) => void): QueryWithHelpers<Array<any>, DocType, THelpers>;
Expand Down

0 comments on commit e2b7553

Please sign in to comment.