summaryrefslogtreecommitdiff
path: root/lib/everyLimit.js
diff options
context:
space:
mode:
authorHubert Argasinski <argasinski.hubert@gmail.com>2016-06-29 01:35:29 -0400
committerHubert Argasinski <argasinski.hubert@gmail.com>2016-06-29 01:56:11 -0400
commit7eaa3b3a9bee0df38ebc0b640a97de42ca05d5da (patch)
tree942b9ea5e9a18f7f55fd01c51555d0c01f82fc5e /lib/everyLimit.js
parent90c4f893a30044b67d48a62e42d2c42f379a822f (diff)
downloadasync-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/everyLimit.js')
-rw-r--r--lib/everyLimit.js9
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/everyLimit.js b/lib/everyLimit.js
index f06a14d..a8cd65a 100644
--- a/lib/everyLimit.js
+++ b/lib/everyLimit.js
@@ -3,13 +3,16 @@ import eachOfLimit from './eachOfLimit';
import notId from './internal/notId';
/**
- * The same as `every` but runs a maximum of `limit` async operations at a time.
+ * ```
+ * import everyLimit from 'async/everyLimit'
+ * ```
+ * The same as [`every`]{@link module:Collections.every} but runs a maximum of `limit` async operations at a time.
*
* @name everyLimit
* @static
- * @memberOf module:async
+ * @memberOf module:Collections
* @method
- * @see [async.every]{@link module:async.every}
+ * @see [async.every]{@link module:Collections.every}
* @alias allLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.