stdlib-js
<summary>
About stdlib...
</summary>
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
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Execute functions in series, passing the results of one function as arguments to the next function.
bash
npm install @stdlib/utils-async-series-waterfall
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();
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).
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 );
