doc(ETIMEDOUT): updating network family autoselection timeout to avoid ETIMEDOUT error #3738
+32
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
updating network family autoselection timeout to avoid ETIMEDOUT error
metcoder95
reviewed
Oct 15, 2024
metcoder95
approved these changes
Oct 20, 2024
Ethan-Arrowood
approved these changes
Oct 21, 2024
mderriey
reviewed
Nov 1, 2024
Co-authored-by: Mickaël Derriey <[email protected]>
metcoder95
approved these changes
Jan 15, 2025
Ethan-Arrowood
approved these changes
Jan 15, 2025
|
|
||
| ### Increasing timeout by updating Node options in package.json | ||
|
|
||
| On example of a NextJS project: |
There was a problem hiding this comment.
Suggested change
| On example of a NextJS project: | |
| One example with a Next.js project: |
|
|
||
| The default timeout depends on local Node version, on Node 18.13.0 and above is 250 milliseconds. | ||
|
|
||
| ### Increasing timeout by updating Node options directly |
There was a problem hiding this comment.
Suggested change
| ### Increasing timeout by updating Node options directly | |
| ### Increasing timeout by updating `NODE_OPTIONS` directly |
|
|
||
| If you are experiencing `TypeError: fetch failed` and you are able to investigate the `cause: AggregateError` and see `code: 'ETIMEDOUT'` it can be very likely due to timeout network family autoselection. This tends to happen with DNS resolving domain to multiple ipv4 and ipv6 addresses. | ||
|
|
||
| The default timeout depends on local Node version, on Node 18.13.0 and above is 250 milliseconds. |
There was a problem hiding this comment.
Suggested change
| The default timeout depends on local Node version, on Node 18.13.0 and above is 250 milliseconds. | |
| The default timeout depends on local Node version, on Node.js 18.13.0 and above is 250 milliseconds. |
|
|
||
| `export NODE_OPTIONS="--network-family-autoselection-attempt-timeout=500"` | ||
|
|
||
| ### Increasing timeout by updating Node options in package.json |
There was a problem hiding this comment.
Suggested change
| ### Increasing timeout by updating Node options in package.json | |
| ### Increasing timeout by updating `NODE_OPTIONS` in package.json |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This relates to...
#2990 (comment)
and likely more issues facing ETIMEDOUT errors related to network family selection ipv4/ipv6
Rationale
Doc update to help debug ETIMOUTED error
Changes
New Doc file added
Features
N/A
Bug Fixes
N/A
Breaking Changes and Deprecations
N/A
Status
N/A