Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(NODE-3867): deprecate cursor count and update v4 docs #3127

Merged
merged 1 commit into from
Feb 4, 2022

Conversation

nbbeeken
Copy link
Contributor

@nbbeeken nbbeeken commented Feb 3, 2022

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

  • Ran npm run check:lint script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: <type>(NODE-xxxx)<!>: <description>
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@baileympearson baileympearson added the Team Review Needs review from team label Feb 4, 2022
@dariakp dariakp changed the title refactor(NODE-3867): document v4 change and deprecate cursor count feat(NODE-3867): deprecate cursor count and update v4 docs Feb 4, 2022
@dariakp dariakp merged commit a48d7e2 into main Feb 4, 2022
@dariakp dariakp deleted the NODE-3867/cursor-count branch February 4, 2022 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team Review Needs review from team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants