The run-async npm package allows you to easily run functions asynchronously, supporting both callback-style and promise-based workflows. It is particularly useful for wrapping functions that use callbacks into a promise-based interface, making it easier to work with in modern JavaScript applications that heavily utilize promises or async/await syntax.

What are run-async's main functionalities?

Running asynchronous functions with callback

This feature allows you to run functions that use the traditional callback pattern asynchronously. The example demonstrates wrapping a setTimeout call, which is asynchronous, in runAsync to handle it with a callback.

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

runAsync(function (callback) {
  setTimeout(function () {
    callback(null, 'result');
  }, 100);
})(function (err, result) {
  console.log(result); // 'result'
});

Using with Promises

This feature demonstrates how run-async can be used to convert a callback-based asynchronous function into a promise-based one. This is particularly useful for integrating older, callback-based APIs into newer codebases that use promises or async/await.

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

const asyncFunction = runAsync(function (callback) {
  setTimeout(function () {
    callback(null, 'result');
  }, 100);
});

asyncFunction().then(result => {
  console.log(result); // 'result'
});

Awaiting asynchronous functions

This feature showcases how run-async can be used with async/await syntax for an even cleaner and more intuitive asynchronous code. It wraps a callback-based asynchronous function and allows it to be awaited.

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

(async () => {
  const asyncFunction = runAsync(function (callback) {
    setTimeout(function () {
      callback(null, 'done');
    }, 100);
  });
  const result = await asyncFunction();
  console.log(result); // 'done'
})();

Other packages similar to run-async

Readme

Source

Run Async

Utility method to run function either synchronously or asynchronously using the common this.async() style. Also provides for promise returning functions.

This is useful for library author accepting sync or async functions as parameter. runAsync will always run them as async method, and normalize the function handling.

Installation

npm install --save run-async

Usage

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

// In Async mode:
var asyncFn = function (a) {
  var done = this.async();

  setTimeout(function () {
    done(null, 'running: ' + a);
  }, 10);
};

runAsync(asyncFn, function (err, answer) {
  console.log(answer); // 'running: async'
}, 'async');

// In Sync mode:
var syncFn = function (a) {
  return 'running: ' + a;
};

runAsync(syncFn, function (err, answer) {
  console.log(answer); // 'running: sync'
}, 'sync');

var promiseFunc = function(a) {
  return new Promise(function (resolve, reject) {
    resolve('running: ' + a);
  });
}

runAsync(promiseFunc, function (err, answer) {
  console.log(answer); // 'running: promise'
}, 'promise');

Licence

Keywords

FAQs

What is run-async?

Is run-async popular?

Is run-async well maintained?

Last updated on 13 Oct 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install