summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Early <alexander.early@gmail.com>2016-04-07 13:45:55 -0700
committerAlex Early <alexander.early@gmail.com>2016-04-07 13:45:55 -0700
commit6ad036d07add9aa24a26b831cd211041d3b681f6 (patch)
tree3b448ba60f3c5cee45a43bdd7672e93687cb17e6 /README.md
parent0a3c1b14654ae8b58839cefdad1e8aa8cf147631 (diff)
parent1d50e729d8fe50bec8e6542145668425ebb829c4 (diff)
downloadasync-6ad036d07add9aa24a26b831cd211041d3b681f6.tar.gz
Merge pull request #1098 from asilvas/named-timeout
#1097. Named timeout for tracking purposes
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index f18239c..77c14ce 100644
--- a/README.md
+++ b/README.md
@@ -2089,13 +2089,15 @@ __Arguments__
* `function` - The asynchronous function you want to set the time limit.
* `miliseconds` - The specified time limit.
+* `info` - *Optional* Any variable you want attached (`string`, `object`, etc) to
+ timeout Error for more information.
__Example__
```js
-async.timeout(function(callback) {
+async.timeout(function nameOfCallback(callback) {
doAsyncTask(callback);
-}, 1000);
+}, 1000, 'more info about timeout');
```
---------------------------------------