Skip to content

Commit 910f9da

Browse files
authored
docs(NODE-7635): clarify IWM options documentation (#4997)
1 parent 95572f3 commit 910f9da

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

src/mongo_client.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,13 +232,17 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
232232
/**
233233
* The maximum number of retries during server overload. Set to 0 to disable overload retries. Defaults to 2.
234234
* @see https://www.mongodb.com/docs/atlas/overload-errors
235+
*
236+
* This option works with MongoDB Atlas Server Version 9.0 and above.
235237
* */
236238
maxAdaptiveRetries?: number;
237239
/**
238240
* Whether or not to enable overload retargeting. Defaults to false.
239241
* @see https://www.mongodb.com/docs/atlas/overload-errors
240242
* More information about the overload policy in drivers:
241243
* @see https://github.com/mongodb/specifications/blob/master/source/client-backpressure/client-backpressure.md#overload-retry-policy
244+
*
245+
* This option works with MongoDB Atlas Server Version 9.0 and above.
242246
* */
243247
enableOverloadRetargeting?: boolean;
244248
/** Allow a driver to force a Single topology type with a connection string containing one host */

0 commit comments

Comments
 (0)