summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorasilvas <asilvas@godaddy.com>2016-04-05 15:28:40 -0700
committerasilvas <asilvas@godaddy.com>2016-04-05 15:28:40 -0700
commitcb703585a83d48a894929c41094a33605c687f97 (patch)
tree5c521ceb9d922bdbcfcd030a2b2202799be1bc1c /README.md
parent5d2f19b360b7ec74db659ae571d730c1acc58b76 (diff)
downloadasync-cb703585a83d48a894929c41094a33605c687f97.tar.gz
#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 79ced0a..10b4cd7 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');
```
---------------------------------------