time-to-botec

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

index.js (1782B)

      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 * Apply a function against an accumulator and each element in a collection and return the accumulated result.
     23 *
     24 * @module @stdlib/utils/async/reduce
     25 *
     26 * @example
     27 * var readFile = require( '@stdlib/fs/read-file' );
     28 * var reduceAsync = require( '@stdlib/utils/async/reduce' );
     29 *
     30 * var files = [
     31 *     './beep.js',
     32 *     './boop.js'
     33 * ];
     34 *
     35 * function done( error, acc ) {
     36 *     if ( error ) {
     37 *         throw error;
     38 *     }
     39 *     console.log( acc.count );
     40 * }
     41 *
     42 * function read( acc, file, next ) {
     43 *     var opts = {
     44 *         'encoding': 'utf8'
     45 *     };
     46 *     readFile( file, opts, onFile );
     47 *
     48 *     function onFile( error ) {
     49 *         if ( error ) {
     50 *             return next( null, acc );
     51 *         }
     52 *         acc.count += 1;
     53 *         next( null, acc );
     54 *     }
     55 * }
     56 *
     57 * var acc = {
     58 *     'count': 0
     59 * };
     60 * reduceAsync( files, acc, read, done );
     61 */
     62 
     63 // MODULES //
     64 
     65 var setReadOnly = require( './../../../define-nonenumerable-read-only-property' );
     66 var reduceAsync = require( './reduce.js' );
     67 var factory = require( './factory.js' );
     68 
     69 
     70 // MAIN //
     71 
     72 setReadOnly( reduceAsync, 'factory', factory );
     73 
     74 
     75 // EXPORTS //
     76 
     77 module.exports = reduceAsync;