docs(readme): add timeout guidance to first async example#10759
Merged
jasonsaayman merged 4 commits intoaxios:v1.xfrom Apr 26, 2026
Merged
docs(readme): add timeout guidance to first async example#10759jasonsaayman merged 4 commits intoaxios:v1.xfrom
jasonsaayman merged 4 commits intoaxios:v1.xfrom
Conversation
jasonsaayman
approved these changes
Apr 26, 2026
This file contains hidden or 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
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.
What changed
README examples now show:
timeout: 5000in the first async exampletimeoutin the promise exampleWhy
A common real-world mistake is leaving HTTP requests without timeouts, causing them to hang indefinitely. Adding timeout examples helps users adopt safer defaults.
Summary by cubic
Adds timeout guidance to the README and getting-started docs to encourage safer
axiosdefaults and prevent hanging requests. Examples now settimeout: 5000and link to matching error handling.Description
README.md: addtimeout: 5000to the Promise-basedaxiosexample and a short note under async examples linking to “Handling Timeouts”./docs/pages/getting-started/first-steps.md: add a “Set a timeout in production” tip with an example and links to request configtimeoutand error handling (ECONNABORTED/ETIMEDOUT).Semantic version impact
Written for commit 02ff2e4. Summary will update on new commits.