Skip to content

docs(NODE-7635): clarify IWM options documentation#4997

Merged
PavelSafronov merged 1 commit into
mainfrom
NODE-7635
Jul 7, 2026
Merged

docs(NODE-7635): clarify IWM options documentation#4997
PavelSafronov merged 1 commit into
mainfrom
NODE-7635

Conversation

@tadjik1

@tadjik1 tadjik1 commented Jul 7, 2026

Copy link
Copy Markdown
Member

Description

Summary of Changes

IWM is going to be part of 9.0 release, clarify our API documentation to link both options with it.

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 marked this pull request as ready for review July 7, 2026 16:03
@tadjik1 tadjik1 requested a review from a team as a code owner July 7, 2026 16:03
Copilot AI review requested due to automatic review settings July 7, 2026 16:03

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the MongoClientOptions API docs to clarify server compatibility for the overload/backpressure (IWM-related) options, aligning the driver’s public TypeScript option documentation with expected server support.

Changes:

  • Added a MongoDB 9.0+ compatibility note to maxAdaptiveRetries.
  • Added a MongoDB 9.0+ compatibility note to enableOverloadRetargeting.

Comment thread src/mongo_client.ts
Comment thread src/mongo_client.ts

@PavelSafronov PavelSafronov left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good.

@PavelSafronov PavelSafronov merged commit 910f9da into main Jul 7, 2026
32 of 34 checks passed
@PavelSafronov PavelSafronov deleted the NODE-7635 branch July 7, 2026 18:03
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.

4 participants