Skip to content

docs(NODE-6589): update maxIdleTimeMS API docs #4579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 10, 2025
Merged

docs(NODE-6589): update maxIdleTimeMS API docs #4579

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4bad6bc
chore(NODE-6589): update maxIdelTimeMS API docs
durran Jul 9, 2025
bb3ae46
Update src/mongo_client.ts
durran Jul 9, 2025
d5e6a10
chore: comments
durran Jul 10, 2025
406bb0d
chore: fix lint
durran Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/mongo_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,11 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
minPoolSize?: number;
/** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
maxConnecting?: number;
/** The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed. */
/**
* The maximum amount of time a connection should remain idle in the connection pool before being marked idle, in milliseconds.
* 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
* time passes, the idle collection can be automatically cleaned up in the background.
*/
maxIdleTimeMS?: number;
/** The maximum time in milliseconds that a thread can wait for a connection to become available. */
waitQueueTimeoutMS?: number;
Expand Down