# async-settle

> Settle an async function.

Latest version **2.0.0** (published 2022-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install async-settle
pnpm add async-settle
yarn add async-settle
bun add async-settle
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2022-06-25 |
| First published | 2014-03-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10.13.0 |
| Dependencies | 1 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Gulp Team |
| Maintainers | yocontra, phated |
| Keywords | settle, async, async-done, complete, error, parallel |

## Links

- npm: https://www.npmjs.com/package/async-settle
- Repository: https://github.com/gulpjs/async-settle
- Homepage: https://github.com/gulpjs/async-settle#readme
- Issues: https://github.com/gulpjs/async-settle/issues
- npm.io page: https://npm.io/package/async-settle

## Dependencies (1)

- [async-done](https://npm.io/package/async-done.md) ^2.0.0

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2022-06-25
- 1.0.0 — 2016-06-26
- 0.2.1 — 2014-08-23
- 0.2.0 — 2014-08-23
- 0.1.0 — 2014-03-10
- 0.0.0 — 2014-03-10

## README

<p align="center">
  <a href="https://gulpjs.com">
    <img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
  </a>
</p>

# 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

<!-- prettier-ignore-start -->
[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/workflow/status/gulpjs/async-settle/dev?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
<!-- prettier-ignore-end -->

<!-- prettier-ignore-start -->
[async-done]: https://github.com/gulpjs/async-done
[completions]: https://github.com/gulpjs/async-done#completion-and-error-resolution
<!-- prettier-ignore-end -->

---
_Source: https://npm.io/package/async-settle · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._