Skip to content

Commit af0bb5a

Browse files
authored
docs(NODE-6589): update maxIdleTimeMS API docs (#4579)
1 parent a09212a commit af0bb5a

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 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 greater than or equal to 0, where 0 means there is no limit. Defaults to 0. After this
190+
* time passes, the idle collection can be automatically cleaned up in the background.
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)