Skip to content

docs: clarify Node.js default for route.options.timeout.socket #4587

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

Closed
Hashim1999164 wants to merge 1 commit into from
+5 −5
Closed

docs: clarify Node.js default for route.options.timeout.socket #4587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 3 deletions API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3433,10 +3433,10 @@ incoming request before giving up and responding with a Service Unavailable (503

#### <a name="route.options.timeout.socket" /> `route.options.timeout.socket`

Default value: none (use node default of 2 minutes).
Default value: none (use node default).

By default, node sockets automatically timeout after 2 minutes. Use this option to override this
behavior. Set to `false` to disable socket timeouts.
By default, Node.js does not timeout sockets (since v13.0.0; earlier versions timed out after 2
minutes). Use this option to override this behavior. Set to `false` to disable socket timeouts.

### <a name="route.options.validate" /> `route.options.validate`

Expand Down
4 changes: 2 additions & 2 deletions lib/types/route.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -855,8 +855,8 @@ export interface CommonRouteProperties<Refs extends ReqRef = ReqRefDefaults> {
server?: boolean | number | undefined;

/**
* @default none (use node default of 2 minutes).
* By default, node sockets automatically timeout after 2 minutes. Use this option to override this behavior. Set to false to disable socket timeouts.
* @default none (use node default).
* By default, Node.js does not timeout sockets (since v13.0.0; earlier versions timed out after 2 minutes). Use this option to override this behavior. Set to false to disable socket timeouts.
*/
socket?: boolean | number | undefined;
} | undefined;
Expand Down