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

Conversation

@ajfranzoia
Copy link
Contributor

ajfranzoia commented Mar 8, 2016

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

@aearly
aearly reviewed Mar 8, 2016
View changes
README.md Outdated

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.

This comment has been minimized.

Copy link
@aearly

aearly Mar 8, 2016

Collaborator

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

@aearly aearly added the docs label Mar 8, 2016
@ajfranzoia ajfranzoia force-pushed the ajfranzoia:timeout-docs branch to f131e68 Mar 8, 2016
@ajfranzoia

This comment has been minimized.

Copy link
Contributor Author

ajfranzoia commented Mar 8, 2016

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
1 check was pending
1 check was pending
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
@aearly

This comment has been minimized.

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
Projects
None yet
2 participants
You can’t perform that action at this time.