https://github.com/gulpjs/async-settle
Settle an async function. It will always complete successfully with an object of the resulting state.
https://github.com/gulpjs/async-settle
Last synced: about 1 year ago
JSON representation
Settle an async function. It will always complete successfully with an object of the resulting state.
- Host: GitHub
- URL: https://github.com/gulpjs/async-settle
- Owner: gulpjs
- License: mit
- Created: 2014-03-10T06:37:44.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T20:13:06.000Z (about 3 years ago)
- Last Synced: 2025-05-08T00:08:36.756Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 21.5 KB
- Stars: 11
- Watchers: 4
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# async-settle
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Coveralls Status][coveralls-image]][coveralls-url]
Settle an async function. It will always complete successfully with an object of the resulting state.
Handles completion and errors for callbacks, promises, observables and streams.
Will run call the function on `nextTick`. This will cause all functions to be async.
## Usage
### Successful completion
```js
var asyncSettle = require('async-settle');
asyncSettle(
function (done) {
// do async things
done(null, 2);
},
function (error, result) {
// `error` will ALWAYS be null on execution of the first function.
// `result` will ALWAYS be a settled object with the result or error of the first function.
}
);
```
### Failed completion
```js
var asyncSettle = require('async-settle');
asyncSettle(
function (done) {
// do async things
done(new Error('Some Error Occurred'));
},
function (error, result) {
// `error` will ALWAYS be null on execution of the first function.
// `result` will ALWAYS be a settled object with the result or error of the first function.
}
);
```
## API
### `asyncSettle(fn, callback)`
Takes a function to execute (`fn`) and a function to call on completion (`callback`).
#### `fn([done])`
Optionally takes a callback (`done`) to call when async tasks are complete.
Executed in the context of [`async-done`][async-done], with all errors and results being settled.
Completion is handled by [`async-done` completion and error resolution][completions].
#### `callback(error, result)`
Called on completion of `fn` and recieves a settled object as the `result` argument.
The `error` argument will always be `null`.
#### Settled Object
Settled values have two properties, `state` and `value`.
`state` has two possible options `'error'` and `'success'`.
`value` will be the value passed to original callback.
## License
MIT
[downloads-image]: https://img.shields.io/npm/dm/async-settle.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/async-settle
[npm-image]: https://img.shields.io/npm/v/async-settle.svg?style=flat-square
[ci-url]: https://github.com/gulpjs/async-settle/actions?query=workflow:dev
[ci-image]: https://img.shields.io/github/actions/workflow/status/gulpjs/async-settle/dev.yml?branch=master&style=flat-square
[coveralls-url]: https://coveralls.io/r/gulpjs/async-settle
[coveralls-image]: https://img.shields.io/coveralls/gulpjs/async-settle/master.svg?style=flat-square
[async-done]: https://github.com/gulpjs/async-done
[completions]: https://github.com/gulpjs/async-done#completion-and-error-resolution