time-to-botec/squiggle/node_modules/@stdlib/utils/async/reduce/lib/index.js

78 lines
1.7 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
/**
* Apply a function against an accumulator and each element in a collection and return the accumulated result.
*
* @module @stdlib/utils/async/reduce
*
* @example
* var readFile = require( '@stdlib/fs/read-file' );
* var reduceAsync = require( '@stdlib/utils/async/reduce' );
*
* var files = [
* './beep.js',
* './boop.js'
* ];
*
* function done( error, acc ) {
* if ( error ) {
* throw error;
* }
* console.log( acc.count );
* }
*
* function read( acc, file, next ) {
* var opts = {
* 'encoding': 'utf8'
* };
* readFile( file, opts, onFile );
*
* function onFile( error ) {
* if ( error ) {
* return next( null, acc );
* }
* acc.count += 1;
* next( null, acc );
* }
* }
*
* var acc = {
* 'count': 0
* };
* reduceAsync( files, acc, read, done );
*/
// MODULES //
var setReadOnly = require( './../../../define-nonenumerable-read-only-property' );
var reduceAsync = require( './reduce.js' );
var factory = require( './factory.js' );
// MAIN //
setReadOnly( reduceAsync, 'factory', factory );
// EXPORTS //
module.exports = reduceAsync;