types(document): correct return type for Model.prototype.deleteOne()
: promise, not query
#13367
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #13223
Summary
As implemented,
doc.deleteOne()
returns a promise, not a query. We could either update thedeleteOne()
implementation to matchupdateOne()
, which does return a query; or we update the TypeScript types. I think changing the TS types is the way to go, because it is less backwards breaking. But we should consider changingdoc.deleteOne()
to return a query in the next major release.Examples