Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chocolateboy/async-any
Manage various forms of asynchronous completion in a uniform way
https://github.com/chocolateboy/async-any
async async-completion callback complete completion done node-module npm-module promise promises
Last synced: 11 days ago
JSON representation
Manage various forms of asynchronous completion in a uniform way
- Host: GitHub
- URL: https://github.com/chocolateboy/async-any
- Owner: chocolateboy
- License: artistic-2.0
- Created: 2018-05-15T01:36:57.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-20T05:27:53.000Z (over 3 years ago)
- Last Synced: 2024-10-01T09:14:26.573Z (3 months ago)
- Topics: async, async-completion, callback, complete, completion, done, node-module, npm-module, promise, promises
- Language: JavaScript
- Homepage:
- Size: 1.03 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# async-any
[](https://travis-ci.org/chocolateboy/async-any)
[](https://www.npmjs.org/package/async-any)
- [NAME](#name)
- [FEATURES](#features)
- [INSTALLATION](#installation)
- [SYNOPSIS](#synopsis)
- [DESCRIPTION](#description)
- [Why?](#why)
- [Why Not?](#why-not)
- [TYPES](#types)
- [EXPORTS](#exports)
- [asyncAny (default)](#asyncany-default)
- [DEVELOPMENT](#development)
- [NPM Scripts](#npm-scripts)
- [COMPATIBILITY](#compatibility)
- [SEE ALSO](#see-also)
- [VERSION](#version)
- [AUTHOR](#author)
- [COPYRIGHT AND LICENSE](#copyright-and-license)
# NAME
async-any - manage various forms of asynchronous completion in a uniform way
# FEATURES
- more lightweight than [async-done](https://www.npmjs.com/package/async-done)
- works in Node.js and the browser
- fully typed (TypeScript)
# INSTALLATION
$ npm install async-any
# SYNOPSIS
```javascript
import asyncAny from 'async-any'
// a task is an asynchronous function which either takes a `done` callback
const task = done => fs.stat(path, done)
// or returns a promise
const task = () => fetch(url)
// asyncAny treats them uniformly and either passes the task's result to a callback
asyncAny(task, (error, result) => { ... })
// or returns it as a promise
const result = await asyncAny(task)
```
# DESCRIPTION
This module exports a function which provides a uniform way to handle tasks
which signal completion asynchronously, either by calling a callback or
returning a promise.
## Why?
I needed a lightweight version of
[async-done](https://www.npmjs.com/package/async-done) with an optional promise
API and browser support.
## Why Not?
async-any doesn't support event emitters, observables, ChildProcess or other
kinds of Node.js [streams](https://github.com/substack/stream-handbook) (unless
they [also](https://github.com/sindresorhus/cp-file) happen to be promises). If
you need support for these, use an adapter such as
[event-to-promise](https://www.npmjs.com/package/event-to-promise) or
[observable-to-promise](https://www.npmjs.com/package/observable-to-promise),
or use async-done.
# TYPES
The following types are referenced in the descriptions below.
```typescript
type Callback = (err: any, result?: T) => void;
type PromiseTask = () => PromiseLike;
type CallbackTask = (done: Callback) => void;
type Task = PromiseTask | CallbackTask;
```
# EXPORTS
## asyncAny (default)
**Signature**:
- `asyncAny(task: Task, callback: Callback): void`
- `asyncAny(task: Task): Promise`
```javascript
import asyncAny from 'async-any'
function runTask (task) {
asyncAny(task, (error, result) => {
if (!error) console.log('got result:', result)
})
}
// or
async function runTask (task) {
const result = await asyncAny(task)
console.log('got result:', result)
}
```
Takes an asynchronous task (function) and an optional callback. The task is
passed a `done`
["errorback"](https://thenodeway.io/posts/understanding-error-first-callbacks/)
function which can be used to signal completion. Alternatively, the task can
return a promise and is deemed complete when it succeeds or fails.
Once the task has completed, its error/result is forwarded to the callback. If
the callback is omitted, a promise is returned, which is fulfilled/rejected by
the task's corresponding result/error.
# DEVELOPMENT
## NPM Scripts
The following NPM scripts are available:
- build - compile the library for testing and save to the target directory
- build:release - compile the library for release and save to the target directory
- clean - remove the target directory and its contents
- doctoc - generate the README's TOC (table of contents)
- rebuild - clean the target directory and recompile the library
- test - recompile the library and run the test suite
- test:run - run the test suite
- typecheck - sanity check the library's type definitions
# COMPATIBILITY
The following [targets](https://browserl.ist/?q=Maintained+Node+versions%2C+Last+2+Chrome+versions%2C+Last+2+Safari+versions%2C+Firefox+ESR) are supported:
- Firefox ESR
- Last 2 Chrome versions
- Last 2 Safari versions
- [Maintained Node.js versions](https://github.com/nodejs/Release#readme)
# SEE ALSO
* [always-done](https://www.npmjs.com/package/always-done)
* [async-done](https://www.npmjs.com/package/async-done)
* [function-done](https://www.npmjs.com/package/function-done)
# VERSION
2.0.0
# AUTHOR
[chocolateboy](mailto:[email protected])
# COPYRIGHT AND LICENSE
Copyright © 2019-2020 by chocolateboy.
This is free software; you can redistribute it and/or modify it under the
terms of the [Artistic License 2.0](https://www.opensource.org/licenses/artistic-license-2.0.php).