Skip to content
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.

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

docs: Add Comment About A Request Lasting Longer Than Its Timeout #1486

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/connection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -765,7 +765,9 @@ export interface ConnectionOptions {
readOnlyIntent?: boolean;

/**
* The number of milliseconds before a request is considered failed, or `0` for no timeout
* The number of milliseconds before a request is considered failed, or `0` for no timeout.
*
* As soon as a response is received, the timeout is cleared. This means that queries that immediately return a response have ability to run longer than this timeout.
*
* (default: `15000`).
*/
Expand Down