feat(NODE-3867): deprecate cursor count and update v4 docs #3127
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.
Description
What is changing?
FindCursor.count will emit a warning once for the duration of the process, and the tsdoc states the deprecation and alternative APIs.
Is there new documentation needed for these changes?
Our API docs will now flag this as deprecated
What is the motivation for this change?
FindCursor.count executes a deprecated operation against MongoDB, countDocuments and estimatedDocumentCount are clearer APIs about what is being done database side.
Double check the following
npm run check:lint
script<type>(NODE-xxxx)<!>: <description>