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

Add entry for async.timeout in README #1051

Merged
merged 1 commit into from
Mar 8, 2016
Merged

Conversation

ajfranzoia
Copy link
Contributor

Updates README with instructions on how to use async.timeout (added in #1027).


Sets a time limit on an asynchronous function. If the function does not call its callback within the specified miliseconds, it will be called with a timeout error. The code property for the error object will be `'ETIMEDOUT'`.

Returns a wrapping function that can be used with any of the control flow functions.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you mean "Returns a wrapped function..."

@aearly aearly added the docs label Mar 8, 2016
@ajfranzoia
Copy link
Contributor Author

Fixed typo :)

aearly added a commit that referenced this pull request Mar 8, 2016
Add entry for async.timeout in README
@aearly aearly merged commit 07208a6 into caolan:master Mar 8, 2016
@aearly
Copy link
Collaborator

aearly commented Mar 8, 2016

💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants