History

Alan Plum 40aff3fdcd Upgrade JS deps (#8773 ) * Make jsunity hash function avoid recursion This guards against traversals of recursive data structures causing a stack overflow. This is crucial when using assertEqual with unknown inputs. * Update deps accepts: 1.3.4 -> 1.3.5 ansi_up: 2.0.2 -> 4.0.3 content-disposition: 0.5.2 -> 0.5.3 dedent: 0.6.0 -> 0.7.0 error-stack-parser: 1.3.6 -> 2.0.2 eslint: 2.13.1 -> 5.16.0 eslint-config-semistandard: 6.0.2 -> removed eslint-config-standard: 5.3.1 -> removed eslint-plugin-promise: 1.3.2 -> removed eslint-plugin-standard: 1.3.2 -> removed highlight.js: 9.12.0 -> 9.15.6 http-errors: 1.6.2 -> 1.7.2 iconv-lite: 0.4.19 -> 0.4.24 joi: 9.2.0 -> 14.3.1 joi-to-json-schema: 2.3.0 -> 4.0.1 js-yaml: 3.10.0 -> 3.13.1 marked: 0.3.9 -> 0.6.2 mime-types: 2.1.12 -> 2.1.22 mocha: 2.5.3 -> 6.1.3 qs: 6.5.1 -> 6.7.0 semver: 5.4.1 -> 6.0.0 statuses: 1.4.0 -> 1.5.0 timezone: 1.0.13 -> 1.0.22 type-is: 1.6.15 -> 1.6.16 underscore: 1.8.3 -> 1.9.1 * Inline eslint semistandard config The eslint standard config has become extremely opinionated and incompatible with the existing coding style. This subset matches the existing coding style most closely. In the future we should migrate to an autoformatter like prettier and avoid this problem altogether. * Linting * Fix mocha runner * New joi has additional property		2019-04-17 13:36:26 +02:00
..
LICENSE	…
README.md	Upgrade JS deps (#8773 )	2019-04-17 13:36:26 +02:00
index.js	Upgrade JS deps (#8773 )	2019-04-17 13:36:26 +02:00
package.json	Upgrade JS deps (#8773 )	2019-04-17 13:36:26 +02:00

README.md

Run Async

Utility method to run a function either synchronously or asynchronously using a series of common patterns. This is useful for library author accepting sync or async functions as parameter. runAsync will always run them as an async method, and normalize the multiple signature.

Installation

npm install --save run-async

Usage

Here's a simple example print the function results and three options a user can provide a function.

var runAsync = require('run-async');

var printAfter = function (func) {
  var cb = function (err, returnValue) {
    console.log(returnValue);
  };
  runAsync(func, cb)(/* arguments for func */);
};

Using `this.async`

printAfter(function () {
  var done = this.async();

  setTimeout(function () {
    done(null, 'done running with callback');
  }, 10);
});

Returning a promise

printAfter(function () {
  return new Promise(function (resolve, reject) {
    resolve('done running with promises');
  });
});

Synchronous function

printAfter(function () {
  return 'done running sync function';
});

runAsync.cb

runAsync.cb supports all the function types that runAsync does and additionally a traditional callback as the last argument signature:

var runAsync = require('run-async');

// IMPORTANT: The wrapped function must have a fixed number of parameters.
runAsync.cb(function(a, b, cb) {
  cb(null, a + b);
}, function(err, result) {
  console.log(result)
})(1, 2)

If your version of node support Promises natively (node >= 0.12), runAsync will return a promise. Example: runAsync(func)(arg1, arg2).then(cb)