Skip to content

feat(NODE-7626): deprecate ObjectId.cacheHexString - #962

Open
tadjik1 wants to merge 1 commit into
mainfrom
NODE-7626
Open

tadjik1 wants to merge 1 commit into
mainfrom
NODE-7626

Conversation

@tadjik1

@tadjik1 tadjik1 commented Nov 6, 2026

Copy link
Copy Markdown
Member

Description

Summary of Changes

Deprecates the static ObjectId.cacheHexString flag. It offers little benefit and will be removed in a future release.

Deprecated ObjectId.cacheHexString

ObjectId.cacheHexString offers little benefit and will be removed in a future release.

Double check the following

  • Lint is passing (npm run check:lint)
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@tadjik1
tadjik1 requested a review from a team as a code owner November 6, 2026 14:06
Copilot AI balanced review requested due to automatic review settings November 6, 2026 14:06

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues were identified for the deprecation notice on ObjectId.cacheHexString.

No open issues 🎉

What changed in this PR

Marks the BSON library’s static ObjectId.cacheHexString flag as deprecated, signaling its planned removal in a future release.

Changes:

  • Adds a JSDoc @deprecated notice explaining that the flag offers little benefit.
  • Leaves the flag’s type and runtime behavior unchanged.
File Description
src/​objectid.ts Adds the deprecation notice to ObjectId.cacheHexString.

Review effort: Balanced

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants