diff options
author | Hubert Argasinski <argasinski.hubert@gmail.com> | 2016-04-06 02:10:35 -0700 |
---|---|---|
committer | Graeme Yeates <yeatesgraeme@gmail.com> | 2016-04-12 18:46:28 -0400 |
commit | 8114c90883857d8390add28976f36d0b9bac31ca (patch) | |
tree | fb06f667b0e1fde4627d552a87d194748461a33d /lib/timesSeries.js | |
parent | 8eb2a7cec2c62edf35d7b812765bd64e6b7d484f (diff) | |
download | async-8114c90883857d8390add28976f36d0b9bac31ca.tar.gz |
jsdoc-style documentation began documenting `Util` methods
remaining `Util` methods to document (10):
- ensureAsync
- constant
- asyncify
- wrapSync
- log
- dir
- noConflict
- timeout
- reflect
- reflectAll
Diffstat (limited to 'lib/timesSeries.js')
-rw-r--r-- | lib/timesSeries.js | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/timesSeries.js b/lib/timesSeries.js index af2219b..dd2ad45 100644 --- a/lib/timesSeries.js +++ b/lib/timesSeries.js @@ -3,4 +3,17 @@ import timesLimit from './timesLimit'; import doLimit from './internal/doLimit'; +/** + * The same as `times` but runs only a single async operation at a time. + * + * @name timesSeries + * @static + * @memberOf async + * @see `async.times` + * @category Util + * @param {number} n - The number of times to run the function. + * @param {Function} iteratee - The function to call `n` times. Invoked with the + * iteration index and a callback (n, next). + * @param {Function} callback - see [`map`](#map). + */ export default doLimit(timesLimit, 1); |