Skip to content

Commit d5e6a10

Browse files
committed
chore: comments
1 parent bb3ae46 commit d5e6a10

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/mongo_client.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,9 +185,9 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
185185
/** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
186186
maxConnecting?: number;
187187
/**
188-
* The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.
189-
* Note that idle connections in the pool can be cleaned up even when minPoolSize is set to 0. For errors that happen
190-
* that include the InterruptInUseConnections label, all non idle connections will be closed as well.
188+
* The maximum amount of time a connection should remain idle in the connection pool before being marked idle, in milliseconds.
189+
* If specified, this must be a number >= 0, where 0 means there is no limit. Defaults to 0. After this time passes, the idle
190+
* collection can be automatically cleaned up in the background.
191191
*/
192192
maxIdleTimeMS?: number;
193193
/** The maximum time in milliseconds that a thread can wait for a connection to become available. */

0 commit comments

Comments
 (0)