Skip to content

Commit 2ea19f7

Browse files
committed
fix descriptions for flags
1 parent 8169205 commit 2ea19f7

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

src/mongo_client.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,15 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
229229
retryReads?: boolean;
230230
/** Enable retryable writes. */
231231
retryWrites?: boolean;
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. */
232+
/**
233+
* The maximum number of retries during server overload. Set to 0 to disable overload retries. Defaults to 2.
234+
* @see https://www.mongodb.com/docs/atlas/overload-errors
235+
* */
233236
maxAdaptiveRetries?: number;
234-
/** Whether or not to enable overload retargeting as described by the https://mongodb.com/docs/atlas/overload-errors. Defaults to false. */
237+
/**
238+
* Whether or not to enable overload retargeting. Defaults to false.
239+
* @see https://www.mongodb.com/docs/atlas/overload-errors
240+
* */
235241
enableOverloadRetargeting?: boolean;
236242
/** Allow a driver to force a Single topology type with a connection string containing one host */
237243
directConnection?: boolean;

0 commit comments

Comments
 (0)