diff options
author | Alexander Early <alexander.early@gmail.com> | 2017-04-01 15:05:52 -0700 |
---|---|---|
committer | Alexander Early <alexander.early@gmail.com> | 2017-04-01 15:05:52 -0700 |
commit | 94a8b2d18bf10cca67cf4c308253f642bbb2b160 (patch) | |
tree | 001afe9b92618fe3ce75e7bdd0979e59ee0a8d63 /lib/asyncify.js | |
parent | faf395c546747c2066e673405e0aec94362811a0 (diff) | |
download | async-94a8b2d18bf10cca67cf4c308253f642bbb2b160.tar.gz |
use the AsyncFunction type in all docs :sweat:
Diffstat (limited to 'lib/asyncify.js')
-rw-r--r-- | lib/asyncify.js | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/asyncify.js b/lib/asyncify.js index 1f0955e..96eea54 100644 --- a/lib/asyncify.js +++ b/lib/asyncify.js @@ -20,10 +20,10 @@ import initialParams from './internal/initialParams'; * @method * @alias wrapSync * @category Util - * @param {Function} func - The synchronous function to convert to an - * asynchronous function. - * @returns {Function} An asynchronous wrapper of the `func`. To be invoked with - * (callback). + * @param {Function} func - The synchronous funuction, or Promise-returning + * function to convert to an {@link AsyncFunction}. + * @returns {AsyncFunction} An asynchronous wrapper of the `func`. To be + * invoked with `(args..., callback)`. * @example * * // passing a regular synchronous function |