@stdlib/utils-async-series-waterfall

Execute functions in series, passing the results of one function as arguments to the next function.

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

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.2%) to scientific vocabulary

Keywords

async consecutive control fcns flow functions javascript node node-js nodejs run sequential series stdlib util utilities utils waterfall

Last synced: 6 months ago · JSON representation

Repository

Execute functions in series, passing the results of one function as arguments to the next function.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 886 KB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

async consecutive control fcns flow functions javascript node node-js nodejs run sequential series stdlib util utilities utils waterfall

Created over 4 years ago · Last pushed about 1 year ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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!

Waterfall

Execute functions in series, passing the results of one function as arguments to the next function.

## Installation ```bash npm install @stdlib/utils-async-series-waterfall ``` 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 waterfall = require( '@stdlib/utils-async-series-waterfall' ); ``` #### waterfall( fcns, clbk\[, thisArg] ) Executes `functions` in series, passing the results of one `function` as arguments to the next `function`. ```javascript function foo( next ) { next( null, 'beep' ); } function bar( str, next ) { console.log( str ); // => 'beep' next(); } function done( error ) { if ( error ) { throw error; } } var fcns = [ foo, bar ]; waterfall( fcns, done ); ``` To set the `this` context for **all** `functions` in the provided function array, provide a `thisArg`. ```javascript function foo( next ) { this.idx = 0; next( null, 'beep' ); } function bar( str, next ) { this.idx += 1; console.log( str ); // => 'beep' next(); } function done( error ) { if ( error ) { throw error; } console.log( ctx.idx ); // => 1 } var ctx = {}; var fcns = [ foo, bar ]; waterfall( fcns, done, ctx ); ``` #### waterfall.factory( fcns, done\[, thisArg] ) Returns a reusable waterfall `function`. ```javascript function foo( next ) { next( null, 'beep' ); } function bar( str, next ) { console.log( str ); // => 'beep' next(); } function done( error ) { if ( error ) { throw error; } } var fcns = [ foo, bar ]; var run = waterfall.factory( fcns, done ); run(); run(); run(); ```

## Notes - The last argument applied to each waterfall `function` is a callback. The callback should be invoked upon a series `function` completion. The first argument is reserved as an `error` argument (which can be `null`). Any results which should be passed to the next `function` in the series should be provided beginning with the second argument. - If any `function` calls the provided callback with a truthy `error` argument, the waterfall suspends execution and immediately calls the `done` callback for subsequent `error` handling. - This implementation does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a `function` which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).

## Examples ```javascript var replace = require( '@stdlib/string-replace' ); var waterfall = require( '@stdlib/utils-async-series-waterfall' ); function foo( next ) { next( null, 'beep' ); } function bar( str, next ) { console.log( str ); next( null, replace( str, 'e', 'o' ) ); } function fun( str, next ) { console.log( str ); next(); } function done( error ) { if ( error ) { throw error; } console.log( 'done' ); } var fcns = [ foo, bar, fun ]; waterfall( fcns, done ); ```

* * * ## 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].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

GitHub Events

Total

Push event: 9

Last Year

Push event: 9

Committers

Last synced: about 2 years ago

All Time

Total Commits: 51
Total Committers: 1
Avg Commits per committer: 51.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 14
Committers: 1
Avg Commits per committer: 14.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	51

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 5 last-month

Total dependent packages: 3
Total dependent repositories: 1
Total versions: 12
Total maintainers: 4

npmjs.org: @stdlib/utils-async-series-waterfall

Execute functions in series, passing the results of one function as arguments to the next function.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 12
Dependent Packages: 3
Dependent Repositories: 1
Downloads: 5 Last month

Rankings

Dependent packages count: 5.9%

Dependent repos count: 10.3%

Average: 13.8%

Forks count: 15.4%

Stargazers count: 16.7%

Downloads: 20.4%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 6 months ago

Dependencies

package.json npm

@stdlib/string-replace ^0.0.x development
@stdlib/utils-noop ^0.0.x development
istanbul ^0.4.1 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-is-function ^0.0.x
@stdlib/assert-is-function-array ^0.0.x
@stdlib/string-format ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-property ^0.0.x

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

@stdlib/utils-async-series-waterfall

Science Score: 26.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Waterfall

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/utils-async-series-waterfall

Rankings

Maintainers (4)

Funding

Dependencies