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

Clarify in README that default timeout is 0 (no timeout) #1750

Merged
merged 1 commit into from Aug 23, 2018

Conversation

@aguynamedben
Copy link
Contributor

commented Aug 22, 2018

I didn't make a GitHub issue since this is such a simple documentation update.

When I Cmd-F to find "timeout" in the README (i.e. GitHub home page for Axios), I see timeout: 1000, but the default is actually 0 (no timeout). Similar to how other configs have their // default listed in a comment, I added a comment to specify that even though the example says timeout is 1000, the default is 0 (no timeout).

This caused confusion in my project with an unreliable API. I couldn't find the source of a queue that was blocking too much, and after a few hours I realized that the Axios timeout is actually 0, not 1000.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.