ensureAsync.js 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. 'use strict';
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.default = ensureAsync;
  6. var _setImmediate = require('./internal/setImmediate');
  7. var _setImmediate2 = _interopRequireDefault(_setImmediate);
  8. var _initialParams = require('./internal/initialParams');
  9. var _initialParams2 = _interopRequireDefault(_initialParams);
  10. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  11. /**
  12. * Wrap an async function and ensure it calls its callback on a later tick of
  13. * the event loop. If the function already calls its callback on a next tick,
  14. * no extra deferral is added. This is useful for preventing stack overflows
  15. * (`RangeError: Maximum call stack size exceeded`) and generally keeping
  16. * [Zalgo](http://blog.izs.me/post/59142742143/designing-apis-for-asynchrony)
  17. * contained.
  18. *
  19. * @name ensureAsync
  20. * @static
  21. * @memberOf module:Utils
  22. * @method
  23. * @category Util
  24. * @param {Function} fn - an async function, one that expects a node-style
  25. * callback as its last argument.
  26. * @returns {Function} Returns a wrapped function with the exact same call
  27. * signature as the function passed in.
  28. * @example
  29. *
  30. * function sometimesAsync(arg, callback) {
  31. * if (cache[arg]) {
  32. * return callback(null, cache[arg]); // this would be synchronous!!
  33. * } else {
  34. * doSomeIO(arg, callback); // this IO would be asynchronous
  35. * }
  36. * }
  37. *
  38. * // this has a risk of stack overflows if many results are cached in a row
  39. * async.mapSeries(args, sometimesAsync, done);
  40. *
  41. * // this will defer sometimesAsync's callback if necessary,
  42. * // preventing stack overflows
  43. * async.mapSeries(args, async.ensureAsync(sometimesAsync), done);
  44. */
  45. function ensureAsync(fn) {
  46. return (0, _initialParams2.default)(function (args, callback) {
  47. var sync = true;
  48. args.push(function () {
  49. var innerArgs = arguments;
  50. if (sync) {
  51. (0, _setImmediate2.default)(function () {
  52. callback.apply(null, innerArgs);
  53. });
  54. } else {
  55. callback.apply(null, innerArgs);
  56. }
  57. });
  58. fn.apply(this, args);
  59. sync = false;
  60. });
  61. }
  62. module.exports = exports['default'];