From b7f9635dd97496670b8afdd68c8354f69ca179c6 Mon Sep 17 00:00:00 2001 From: Hashim Khan Date: Thu, 23 Jul 2026 05:00:00 +0500 Subject: [PATCH] docs: clarify Node.js default for route.options.timeout.socket Node.js no longer times out sockets by default since v13.0.0; the previous 2-minute default is outdated. Update API.md and type docs to match current Node behavior. Closes #4468 --- API.md | 6 +++--- lib/types/route.d.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/API.md b/API.md index deea46d3b..24802adcc 100755 --- a/API.md +++ b/API.md @@ -3433,10 +3433,10 @@ incoming request before giving up and responding with a Service Unavailable (503 #### `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. ### `route.options.validate` diff --git a/lib/types/route.d.ts b/lib/types/route.d.ts index f85cf00d8..e0248a40b 100644 --- a/lib/types/route.d.ts +++ b/lib/types/route.d.ts @@ -855,8 +855,8 @@ export interface CommonRouteProperties { 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;