Skip to content

Commit 8169205

Browse files
committed
update parameter descriptions
1 parent c436876 commit 8169205

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

src/mongo_client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,9 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
229229
retryReads?: boolean;
230230
/** Enable retryable writes. */
231231
retryWrites?: boolean;
232-
/** The maximum number of retries for overload errors. Set to 0 to disable overload retries. Defaults to 2. */
232+
/** The maximum number of overload retries as described by the https://mongodb.com/docs/atlas/overload-errors. Set to 0 to disable overload retries. Defaults to 2. */
233233
maxAdaptiveRetries?: number;
234-
/** Whether to deprioritize servers that return overload errors during retry server selection. Defaults to false. */
234+
/** Whether or not to enable overload retargeting as described by the https://mongodb.com/docs/atlas/overload-errors. Defaults to false. */
235235
enableOverloadRetargeting?: boolean;
236236
/** Allow a driver to force a Single topology type with a connection string containing one host */
237237
directConnection?: boolean;

0 commit comments

Comments
 (0)