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/ensureAsync.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/ensureAsync.js')
-rw-r--r-- | lib/ensureAsync.js | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/ensureAsync.js b/lib/ensureAsync.js index bd0b29a..6ef698e 100644 --- a/lib/ensureAsync.js +++ b/lib/ensureAsync.js @@ -2,6 +2,9 @@ import setImmediate from './internal/setImmediate'; import initialParams from './internal/initialParams'; /** + * ``` + * import ensureAsync from 'async/ensureAsync' + * ``` * Wrap an async function and ensure it calls its callback on a later tick of * the event loop. If the function already calls its callback on a next tick, * no extra deferral is added. This is useful for preventing stack overflows @@ -11,7 +14,7 @@ import initialParams from './internal/initialParams'; * * @name ensureAsync * @static - * @memberOf module:async + * @memberOf module:Utils * @method * @category Util * @param {Function} fn - an async function, one that expects a node-style |