@stdlib/utils-reduce 0.0.7 → 0.1.0

package/docs/repl.txt

@@ -1,45 +0,0 @@
-
-{{alias}}( collection, initial, reducer[, thisArg] )
-    Applies a function against an accumulator and each element in a collection
-    and returns the accumulated result.
-
-    When invoked, the reduction function is provided four arguments:
-
-    - `accumulator`: accumulated value
-    - `value`: collection value
-    - `index`: collection index
-    - `collection`: the input collection
-
-    If provided an empty collection, the function returns the initial value.
-
-    Parameters
-    ----------
-    collection: Array|TypedArray|Object
-        Input collection. If provided an object, the object must be array-like
-        (excluding strings and functions).
-
-    initial: any
-        Accumulator value used in the first invocation of the reduction
-        function.
-
-    reducer: Function
-        Function to invoke for each element in the input collection.
-
-    thisArg: any (optional)
-        Execution context.
-
-    Returns
-    -------
-    out: any
-        Accumulated result.
-
-    Examples
-    --------
-    > function sum( acc, v ) { return acc + v; };
-    > var arr = [ 1.0, 2.0, 3.0 ];
-    > var out = {{alias}}( arr, 0, sum )
-    6.0
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,59 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2019 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.
-*/
-
-import reduce = require( './index' );
-
-const sum = ( acc: number, value: number ): number => {
-	return acc + value;
-};
-
-
-// TESTS //
-
-// The function returns the accumulated value...
-{
-	reduce( [ 0, 1, 1, NaN, 2 ], 0, sum ); // $ExpectType any
-	reduce( [ -1, 1, 2 ], 100, sum ); // $ExpectType any
-	reduce( [ -1, 1, 2 ], 0, sum, {} ); // $ExpectType any
-}
-
-// The compiler throws an error if the function is provided a first argument which is not a collection...
-{
-	reduce( 2, 0, sum ); // $ExpectError
-	reduce( false, 0, sum ); // $ExpectError
-	reduce( true, 0, sum ); // $ExpectError
-	reduce( {}, 0, sum ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a third argument which is not a function...
-{
-	reduce( [ 0, 1, 1, NaN, 2 ], 0, 2 ); // $ExpectError
-	reduce( [ 0, 1, 1, NaN, 2 ], 0, false ); // $ExpectError
-	reduce( [ 0, 1, 1, NaN, 2 ], 0, true ); // $ExpectError
-	reduce( [ 0, 1, 1, NaN, 2 ], 0, 'abc' ); // $ExpectError
-	reduce( [ 0, 1, 1, NaN, 2 ], 0, {} ); // $ExpectError
-	reduce( [ 0, 1, 1, NaN, 2 ], 0, [] ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an invalid number of arguments...
-{
-	reduce(); // $ExpectError
-	reduce( [ 1, 2, 3 ] ); // $ExpectError
-	reduce( [ 1, 2, 3 ], 0 ); // $ExpectError
-	reduce( [ 1, 2, 3 ], 0, sum, {}, 3 ); // $ExpectError
-}

package/lib/reduce.js

@@ -1,76 +0,0 @@
-/**
-* @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';
-
-// MODULES //
-
-var isCollection = require( '@stdlib/assert-is-collection' );
-var isFunction = require( '@stdlib/assert-is-function' );
-
-
-// MAIN //
-
-/**
-* Applies a function against an accumulator and each element in a collection and returns the accumulated result.
-*
-* @param {Collection} collection - input collection
-* @param {*} initial - initial value
-* @param {Function} reducer - reduction function
-* @param {*} [thisArg] - reduction function execution context
-* @throws {TypeError} first argument must be a collection
-* @throws {TypeError} third argument must be a function
-* @returns {*} accumulated result
-*
-* @example
-* function sum( acc, value ) {
-*     return acc + value;
-* }
-*
-* var arr = [ 1, 2, 3, 4 ];
-*
-* var s = reduce( arr, 0, sum );
-* // returns 10
-*/
-function reduce( collection, initial, reducer, thisArg ) {
-	var len;
-	var acc;
-	var i;
-	if ( !isCollection( collection ) ) {
-		throw new TypeError( 'invalid argument. First argument must be a collection. Value: `'+collection+'`.' );
-	}
-	if ( !isFunction( reducer ) ) {
-		throw new TypeError( 'invalid argument. Third argument must be a function. Value:`'+reducer+'`.' );
-	}
-	len = collection.length;
-	acc = initial;
-	for ( i = 0; i < len; i++ ) {
-		acc = reducer.call( thisArg, acc, collection[ i ], i, collection );
-
-		// Account for dynamically resizing a collection...
-		if ( len !== collection.length ) {
-			len = collection.length;
-		}
-	}
-	return acc;
-}
-
-
-// EXPORTS //
-
-module.exports = reduce;