diff options
Diffstat (limited to 'lib/nextTick.js')
-rw-r--r-- | lib/nextTick.js | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/lib/nextTick.js b/lib/nextTick.js index 05d9555..249bec2 100644 --- a/lib/nextTick.js +++ b/lib/nextTick.js @@ -2,4 +2,34 @@ import setImmediate from './internal/setImmediate'; +/** + * Calls `callback` on a later loop around the event loop. In Node.js this just + * calls `setImmediate`. In the browser it will use `setImmediate` if + * available, otherwise `setTimeout(callback, 0)`, which means other higher + * priority events may precede the execution of `callback`. + * + * This is used internally for browser-compatibility purposes. + * + * @name nextTick + * @static + * @memberOf async + * @alias setImmediate + * @category Util + * @param {Function} callback - The function to call on a later loop around + * the event loop. Invoked with (args...). + * @param {...*} args... - any number of additional arguments to pass to the + * callback on the next tick. + * @example + * + * var call_order = []; + * async.nextTick(function() { + * call_order.push('two'); + * // call_order now equals ['one','two'] + * }); + * call_order.push('one'); + * + * async.setImmediate(function (a, b, c) { + * // a, b, and c equal 1, 2, and 3 + * }, 1, 2, 3); + */ export default setImmediate; |