Skip to content

Commit 4bad6bc

Browse files
committed
chore(NODE-6589): update maxIdelTimeMS API docs
1 parent bff57ed commit 4bad6bc

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/mongo_client.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,11 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
184184
minPoolSize?: number;
185185
/** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
186186
maxConnecting?: number;
187-
/** The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed. */
187+
/**
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 whe minPoolSize is set to 0. For errors that happen
190+
* that include the InterruptInUseConnections label, all non idle connections will be closed as well.
191+
*/
188192
maxIdleTimeMS?: number;
189193
/** The maximum time in milliseconds that a thread can wait for a connection to become available. */
190194
waitQueueTimeoutMS?: number;

0 commit comments

Comments
 (0)