# ondone

> Wait for one or more async functions to be done.

Latest version **1.0.0** (published 2014-11-14) · BSD license · 0 weekly downloads

## Install

```sh
npm install ondone
pnpm add ondone
yarn add ondone
bun add ondone
```

## 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 | 1.0.0 |
| Published | 2014-11-14 |
| First published | 2014-11-14 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mikito Takada |
| Maintainers | mixu |
| Keywords | async, flow, parallel, callback, cancel |

## Links

- npm: https://www.npmjs.com/package/ondone
- Repository: https://github.com/mixu/ondone
- Issues: https://github.com/mixu/ondone/issues
- npm.io page: https://npm.io/package/ondone

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2014-11-14

## README

# ondone

Wait for one or more async functions to be done.

## Installation

```js
npm install --save ondone
```

## API

```js
var ondone = require('ondone');
tasks = ondone(tasks, doneFn);
```

`ondone` accepts an array of `tasks` and a done function (`doneFn`). It returns an array of functions that can be passed to any async execution engine (like `miniq` or `async.js`). It adds the following functionality:

- once all of the tasks have completed, the done function is called (with no error or result argument)
- if any of the tasks returns an error:
    - the done function is called with the error
    - the other tasks passed in the same array will be cancelled (will become no-ops)
- if the done function to any callback is called twice, an error is thrown

In short, this is "waiting for tasks to complete" portion of async execution without the actual task execution logic. It helps keep async runners smaller (ondone is ~1000 bytes unminified) while allowing them to support more flexible task batching.

Tasks are callbacks that have a signature such as:

- `function(done) {}`
- `function(arg1, done) {}`
- `function(arg1, arg2, ..., done)`

that is, the last argument to each task must be a `done` function. The `done` function should accept an `err` (error) parameter as it's first argument, and may have additional arguments after the `err` argument, e.g.:

- `function done(err) {}`
- `function done(err, arg) {}`
- `function done(err, arg1, arg2, ...) {}`

## Example

Here, I'm taking a set of tasks and dividing it into two sets of tasks. When each set of tasks completes, the done function for that set is called:

```js
var completedFirst = false,
    completedSecond = false;
async.waterfall(
    ondone([
      function(callback){ callback(null, 'one', 'two'); },
      function(arg1, arg2, callback){ callback(null, arg1 + arg2 + 'three');}
      ], function() { completedFirst = true; })
    .concat(
      ondone([
        function(arg1, callback){ callback(null, arg1 + 'done'); }
      ], function() { completedSecond = true; }))
  , function (err, result) {
  assert.equal(result, 'onetwothreedone');
  assert.ok(completedFirst);
  assert.ok(completedSecond);
});
```

# Related

- https://github.com/ifit/waitress
- https://github.com/eldargab/asyncloop
- https://github.com/stagas/waits
- https://github.com/taoyuan/cancelify
- https://github.com/socialradar/hold
- https://github.com/adamhalasz/nextjs
- https://github.com/KoryNunn/wait-for

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