index.js (1462B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Execute functions in series, passing the results of one function as arguments to the next function. 23 * 24 * @module @stdlib/utils/async/series-waterfall 25 * 26 * @example 27 * var waterfall = require( '@stdlib/utils/async/series-waterfall' ); 28 * 29 * function foo( next ) { 30 * next( null, 'beep' ); 31 * } 32 * 33 * function bar( str, next ) { 34 * console.log( str ); 35 * // => 'beep' 36 * 37 * next(); 38 * } 39 * 40 * function done( error ) { 41 * if ( error ) { 42 * throw error; 43 * } 44 * } 45 * 46 * var fcns = [ foo, bar ]; 47 * 48 * waterfall( fcns, done ); 49 */ 50 51 // MODULES // 52 53 var setReadOnly = require( './../../../define-nonenumerable-read-only-property' ); 54 var waterfall = require( './waterfall.js' ); 55 var factory = require( './factory.js' ); 56 57 58 // MAIN // 59 60 setReadOnly( waterfall, 'factory', factory ); 61 62 63 // EXPORTS // 64 65 module.exports = waterfall;