time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

waterfall.js (1530B)

      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 // MODULES //
     22 
     23 var factory = require( './factory.js' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Executes functions in series, passing the results of one function as arguments to the next function.
     30 *
     31 * @param {FunctionArray} fcns - array of functions
     32 * @param {Callback} clbk - callback to invoke upon completion
     33 * @param {*} [thisArg] - function context
     34 * @throws {TypeError} first argument must be an array of functions
     35 * @throws {TypeError} second argument must be a function
     36 *
     37 * @example
     38 * function foo( next ) {
     39 *     next( null, 'beep' );
     40 * }
     41 *
     42 * function bar( str, next ) {
     43 *     console.log( str );
     44 *     // => 'beep'
     45 *
     46 *     next();
     47 * }
     48 *
     49 * function done( error ) {
     50 *     if ( error ) {
     51 *         throw error;
     52 *     }
     53 * }
     54 *
     55 * var fcns = [ foo, bar ];
     56 *
     57 * waterfall( fcns, done );
     58 */
     59 function waterfall( fcns, clbk, thisArg ) {
     60 	factory( fcns, clbk, thisArg )();
     61 }
     62 
     63 
     64 // EXPORTS //
     65 
     66 module.exports = waterfall;