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/dir.js | |
parent | faf395c546747c2066e673405e0aec94362811a0 (diff) | |
download | async-94a8b2d18bf10cca67cf4c308253f642bbb2b160.tar.gz |
use the AsyncFunction type in all docs :sweat:
Diffstat (limited to 'lib/dir.js')
-rw-r--r-- | lib/dir.js | 13 |
1 files changed, 7 insertions, 6 deletions
@@ -1,10 +1,11 @@ import consoleFunc from './internal/consoleFunc'; /** - * Logs the result of an `async` function to the `console` using `console.dir` - * to display the properties of the resulting object. Only works in Node.js or - * in browsers that support `console.dir` and `console.error` (such as FF and - * Chrome). If multiple arguments are returned from the async function, + * Logs the result of an [`async` function]{@link AsyncFunction} to the + * `console` using `console.dir` to display the properties of the resulting object. + * Only works in Node.js or in browsers that support `console.dir` and + * `console.error` (such as FF and Chrome). + * If multiple arguments are returned from the async function, * `console.dir` is called on each argument in order. * * @name dir @@ -12,8 +13,8 @@ import consoleFunc from './internal/consoleFunc'; * @memberOf module:Utils * @method * @category Util - * @param {Function} function - The function you want to eventually apply all - * arguments to. + * @param {AsyncFunction} function - The function you want to eventually apply + * all arguments to. * @param {...*} arguments... - Any number of arguments to apply to the function. * @example * |