Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/stdlib-js/utils-async

Standard async utilities.
https://github.com/stdlib-js/utils-async
async asynchronous javascript node node-js nodejs stdlib util utilities utility utils
Last synced: 26 days ago
JSON representation
Standard async utilities.
Host: GitHub
URL: https://github.com/stdlib-js/utils-async
Owner: stdlib-js
License: apache-2.0
Created: 2021-06-14T16:45:44.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-12-01T09:07:45.000Z (about 2 months ago)
Last Synced: 2024-12-12T02:05:24.625Z (about 1 month ago)
Topics: async, asynchronous, javascript, node, node-js, nodejs, stdlib, util, utilities, utility, utils
Language: JavaScript
Homepage: https://github.com/stdlib-js/stdlib
Size: 2.6 MB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project

README

        

  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

  The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

  When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

  To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!


# Async

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 

> Async utilities.

## Installation

```bash

npm install @stdlib/utils-async

```

Alternatively,

-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).

The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage

```javascript

var ns = require( '@stdlib/utils-async' );

```

#### ns

Namespace containing async utilities.

```javascript

var o = ns;

// returns {...}

```



-   [`anyByRightAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/any-by-right]: test whether at least one element in a collection passes a test implemented by a predicate function, iterating from right to left.

-   [`anyByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/any-by]: test whether at least one element in a collection passes a test implemented by a predicate function.

-   [`bifurcateByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/bifurcate-by]: split values into two groups according to a predicate function.

-   [`composeAsync( ...fcn )`][@stdlib/utils/async/compose]: function composition.

-   [`countByAsync( collection, [options,] indicator, done )`][@stdlib/utils/async/count-by]: group values according to an indicator function and return group counts.

-   [`doUntilAsync( fcn, predicate, done[, thisArg ] )`][@stdlib/utils/async/do-until]: invoke a function until a test condition is true.

-   [`doWhileAsync( fcn, predicate, done[, thisArg ] )`][@stdlib/utils/async/do-while]: invoke a function while a test condition is true.

-   [`everyByRightAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/every-by-right]: test whether all elements in a collection pass a test implemented by a predicate function, iterating from right to left.

-   [`everyByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/every-by]: test whether all elements in a collection pass a test implemented by a predicate function.

-   [`forEachRightAsync( collection, [options,] fcn, done )`][@stdlib/utils/async/for-each-right]: invoke a function once for each element in a collection, iterating from right to left.

-   [`forEachAsync( collection, [options,] fcn, done )`][@stdlib/utils/async/for-each]: invoke a function once for each element in a collection.

-   [`functionSequenceAsync( ...fcn )`][@stdlib/utils/async/function-sequence]: function sequence.

-   [`groupByAsync( collection, [options,] indicator, done )`][@stdlib/utils/async/group-by]: group values according to an indicator function.

-   [`ifelseAsync( predicate, x, y, done )`][@stdlib/utils/async/if-else]: if a predicate function returns a truthy value, return `x`; otherwise, return `y`.

-   [`ifthenAsync( predicate, x, y, done )`][@stdlib/utils/async/if-then]: if a predicate function returns a truthy value, invoke `x`; otherwise, invoke `y`.

-   [`inmapRightAsync( collection, [options,] fcn, done )`][@stdlib/utils/async/inmap-right]: invoke a function for each element in a collection and update the collection in-place, iterating from right to left.

-   [`inmapAsync( collection, [options,] fcn, done )`][@stdlib/utils/async/inmap]: invoke a function for each element in a collection and update the collection in-place.

-   [`mapFunAsync( fcn, n, [options,] done )`][@stdlib/utils/async/map-function]: invoke a function `n` times and return an array of accumulated function return values.

-   [`mapKeysAsync( obj, [options,] transform, done )`][@stdlib/utils/async/map-keys]: map keys from one object to a new object having the same values.

-   [`mapValuesAsync( obj, [options,] transform, done )`][@stdlib/utils/async/map-values]: map values from one object to a new object having the same keys.

-   [`noneByRightAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/none-by-right]: test whether all elements in a collection fail a test implemented by a predicate function, iterating from right to left.

-   [`noneByAsync( collection, [options,] predicate, done )`][@stdlib/utils/async/none-by]: test whether all elements in a collection fail a test implemented by a predicate function.

-   [`reduceRightAsync( collection, initial, [options,] reducer, done )`][@stdlib/utils/async/reduce-right]: apply a function against an accumulator and each element in a collection and return the accumulated result, iterating from right to left.

-   [`reduceAsync( collection, initial, [options,] reducer, done )`][@stdlib/utils/async/reduce]: apply a function against an accumulator and each element in a collection and return the accumulated result.

-   [`waterfall( fcns, clbk[, thisArg] )`][@stdlib/utils/async/series-waterfall]: execute functions in series, passing the results of one function as arguments to the next function.

-   [`someByRightAsync( collection, n, [options,] predicate, done )`][@stdlib/utils/async/some-by-right]: test whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.

-   [`someByAsync( collection, n, [options,] predicate, done )`][@stdlib/utils/async/some-by]: test whether a collection contains at least `n` elements which pass a test implemented by a predicate function.

-   [`tabulateByAsync( collection, [options,] indicator, done )`][@stdlib/utils/async/tabulate-by]: generate a frequency table according to an indicator function.

-   [`trycatchAsync( x, y, done )`][@stdlib/utils/async/try-catch]: if a function does not return an error, invoke a callback with the function result; otherwise, invoke a callback with a value `y`.

-   [`trythenAsync( x, y, done )`][@stdlib/utils/async/try-then]: if a function does not return an error, invoke a callback with the function result; otherwise, invoke a second function.

-   [`untilAsync( predicate, fcn, done[, thisArg ] )`][@stdlib/utils/async/until]: invoke a function until a test condition is true.

-   [`whileAsync( predicate, fcn, done[, thisArg ] )`][@stdlib/utils/async/while]: invoke a function while a test condition is true.



## Examples

```javascript

var objectKeys = require( '@stdlib/utils-keys' );

var ns = require( '@stdlib/utils-async' );

console.log( objectKeys( ns ) );

```

* * *

## Notice

This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].

## Copyright

Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-async.svg

[npm-url]: https://npmjs.org/package/@stdlib/utils-async

[test-image]: https://github.com/stdlib-js/utils-async/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/utils-async/actions/workflows/test.yml?query=branch:main

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-async/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/utils-async?branch=main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/utils-async/tree/deno

[deno-readme]: https://github.com/stdlib-js/utils-async/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/utils-async/tree/umd

[umd-readme]: https://github.com/stdlib-js/utils-async/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/utils-async/tree/esm

[esm-readme]: https://github.com/stdlib-js/utils-async/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/utils-async/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async/main/LICENSE

[@stdlib/utils/async/any-by-right]: https://github.com/stdlib-js/utils-async-any-by-right

[@stdlib/utils/async/any-by]: https://github.com/stdlib-js/utils-async-any-by

[@stdlib/utils/async/bifurcate-by]: https://github.com/stdlib-js/utils-async-bifurcate-by

[@stdlib/utils/async/compose]: https://github.com/stdlib-js/utils-async-compose

[@stdlib/utils/async/count-by]: https://github.com/stdlib-js/utils-async-count-by

[@stdlib/utils/async/do-until]: https://github.com/stdlib-js/utils-async-do-until

[@stdlib/utils/async/do-while]: https://github.com/stdlib-js/utils-async-do-while

[@stdlib/utils/async/every-by-right]: https://github.com/stdlib-js/utils-async-every-by-right

[@stdlib/utils/async/every-by]: https://github.com/stdlib-js/utils-async-every-by

[@stdlib/utils/async/for-each-right]: https://github.com/stdlib-js/utils-async-for-each-right

[@stdlib/utils/async/for-each]: https://github.com/stdlib-js/utils-async-for-each

[@stdlib/utils/async/function-sequence]: https://github.com/stdlib-js/utils-async-function-sequence

[@stdlib/utils/async/group-by]: https://github.com/stdlib-js/utils-async-group-by

[@stdlib/utils/async/if-else]: https://github.com/stdlib-js/utils-async-if-else

[@stdlib/utils/async/if-then]: https://github.com/stdlib-js/utils-async-if-then

[@stdlib/utils/async/inmap-right]: https://github.com/stdlib-js/utils-async-inmap-right

[@stdlib/utils/async/inmap]: https://github.com/stdlib-js/utils-async-inmap

[@stdlib/utils/async/map-function]: https://github.com/stdlib-js/utils-async-map-function

[@stdlib/utils/async/map-keys]: https://github.com/stdlib-js/utils-async-map-keys

[@stdlib/utils/async/map-values]: https://github.com/stdlib-js/utils-async-map-values

[@stdlib/utils/async/none-by-right]: https://github.com/stdlib-js/utils-async-none-by-right

[@stdlib/utils/async/none-by]: https://github.com/stdlib-js/utils-async-none-by

[@stdlib/utils/async/reduce-right]: https://github.com/stdlib-js/utils-async-reduce-right

[@stdlib/utils/async/reduce]: https://github.com/stdlib-js/utils-async-reduce

[@stdlib/utils/async/series-waterfall]: https://github.com/stdlib-js/utils-async-series-waterfall

[@stdlib/utils/async/some-by-right]: https://github.com/stdlib-js/utils-async-some-by-right

[@stdlib/utils/async/some-by]: https://github.com/stdlib-js/utils-async-some-by

[@stdlib/utils/async/tabulate-by]: https://github.com/stdlib-js/utils-async-tabulate-by

[@stdlib/utils/async/try-catch]: https://github.com/stdlib-js/utils-async-try-catch

[@stdlib/utils/async/try-then]: https://github.com/stdlib-js/utils-async-try-then

[@stdlib/utils/async/until]: https://github.com/stdlib-js/utils-async-until

[@stdlib/utils/async/while]: https://github.com/stdlib-js/utils-async-while