https://github.com/sboudrias/run-async
Utility method to run function either synchronously or asynchronously using the common `this.async()` style.
https://github.com/sboudrias/run-async
Last synced: 6 months ago
JSON representation
Utility method to run function either synchronously or asynchronously using the common `this.async()` style.
- Host: GitHub
- URL: https://github.com/sboudrias/run-async
- Owner: SBoudrias
- License: mit
- Created: 2014-08-11T00:35:20.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2025-01-10T21:54:23.000Z (9 months ago)
- Last Synced: 2025-04-11T12:27:00.665Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 51.8 KB
- Stars: 23
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Run Async
=========
[](http://badge.fury.io/js/run-async) [](http://travis-ci.org/SBoudrias/run-async) [](https://david-dm.org/SBoudrias/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
=========
```bash
npm install --save run-async
```
Usage
=========
Here's a simple example print the function results and three options a user can provide a function.
```js
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`
```js
printAfter(function () {
var done = this.async();
setTimeout(function () {
done(null, 'done running with callback');
}, 10);
});
```
#### Returning a promise
```js
printAfter(function () {
return new Promise(function (resolve, reject) {
resolve('done running with promises');
});
});
```
#### Synchronous function
```js
printAfter(function () {
return 'done running sync function';
});
```
#### Custom done factory
```js
var runAsync = require('run-async');
runAsync(function() {
var callback = this.customAsync();
callback(null, a + b);
}, 'customAsync')(1, 2)
```
#### Passing context to async method
```js
var runAsync = require('run-async');
runAsync(function() {
assert(this.isBound);
var callback = this.async();
callback(null, a + b);
}).call({ isBound: true }, 1, 2)
```
### runAsync.cb
`runAsync.cb` supports all the function types that `runAsync` does and additionally a traditional **callback as the last argument** signature:
```js
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)`
Licence
========
Copyright (c) 2014 Simon Boudrias (twitter: @vaxilart)
Licensed under the MIT license.