diff options
author | Hubert Argasinski <argasinski.hubert@gmail.com> | 2016-06-29 01:35:29 -0400 |
---|---|---|
committer | Hubert Argasinski <argasinski.hubert@gmail.com> | 2016-06-29 01:56:11 -0400 |
commit | 7eaa3b3a9bee0df38ebc0b640a97de42ca05d5da (patch) | |
tree | 942b9ea5e9a18f7f55fd01c51555d0c01f82fc5e /lib/detectLimit.js | |
parent | 90c4f893a30044b67d48a62e42d2c42f379a822f (diff) | |
download | async-7eaa3b3a9bee0df38ebc0b640a97de42ca05d5da.tar.gz |
jsdocs: using proxy modules as categories, modifying minami theme
jsdocs: style fix in outputted html
jsdoc: added documentation to support script
Diffstat (limited to 'lib/detectLimit.js')
-rw-r--r-- | lib/detectLimit.js | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/lib/detectLimit.js b/lib/detectLimit.js index 335add4..6911fb9 100644 --- a/lib/detectLimit.js +++ b/lib/detectLimit.js @@ -5,16 +5,19 @@ import eachOfLimit from './eachOfLimit'; import findGetResult from './internal/findGetResult'; /** - * The same as `detect` but runs a maximum of `limit` async operations at a + * ``` + * import detectLimit from 'async/detectLimit' + * ``` + * The same as [`detect`]{@link module:Collections.detect} but runs a maximum of `limit` async operations at a * time. * * @name detectLimit * @static - * @memberOf module:async + * @memberOf module:Collections * @method - * @see [async.detect]{@link module:async.detect} + * @see [async.detect]{@link module:Collections.detect} * @alias findLimit - * @category Collection + * @category Collections * @param {Array|Object} coll - A collection to iterate over. * @param {number} limit - The maximum number of async operations at a time. * @param {Function} iteratee - A truth test to apply to each item in `coll`. |