@stdlib/utils-async-inmap-right 0.0.7 → 0.1.0

package/docs/types/index.d.ts

@@ -16,43 +16,43 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/object';
+import { Collection } from '@stdlib/types/array';
 
 /**
 * Interface defining function options.
 */
-interface Options {
+interface Options<T, U, V> {
 	/**
-	* The maximum number of pending invocations at any one time.
+	* Execution context.
 	*/
-	limit?: number;
+	thisArg?: ThisParameterType<Fcn<T, U, V>>;
 
 	/**
-	* Boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection (default: false).
+	* The maximum number of pending invocations at any one time.
 	*/
-	series?: boolean;
+	limit?: number;
 
 	/**
-	* Execution context.
+	* Boolean indicating whether to sequentially invoke the provided function for each `collection` element. If `true`, the function sets `options.limit=1`. Default: false.
 	*/
-	thisArg?: any;
+	series?: boolean;
 }
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.
 */
-type DoneNullary = () => void;
+type Nullary = () => void;
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.
 *
 * @param error - error argument
 */
-type DoneUnary = ( error: Error ) => void;
+type Unary = ( error: Error ) => void;
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.
@@ -60,7 +60,7 @@ type DoneUnary = ( error: Error ) => void;
 * @param error - error argument
 * @param collection - updated input collection
 */
-type DoneBinary = ( error: Error, collection: Collection ) => void;
+type Binary<U> = ( error: Error, collection: Collection<U> ) => void;
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.
@@ -68,15 +68,14 @@ type DoneBinary = ( error: Error, collection: Collection ) => void;
 * @param error - error argument
 * @param collection - updated input collection
 */
-type DoneCallback = DoneNullary | DoneUnary | DoneBinary;
+type Callback<U> = Nullary | Unary | Binary<U>;
 
 /**
 * Callback function.
 *
 * @param error - error argument
-* @param result - value used to update the collection
 */
-type Unary = ( error: Error ) => void;
+type UnaryNext = ( error: Error ) => void;
 
 /**
 * Callback function.
@@ -84,7 +83,7 @@ type Unary = ( error: Error ) => void;
 * @param error - error argument
 * @param result - value used to update the collection
 */
-type Binary = ( error: Error | null, result: any ) => void;
+type BinaryNext<U> = ( error: Error | null, result: U ) => void;
 
 /**
 * Callback function.
@@ -92,7 +91,7 @@ type Binary = ( error: Error | null, result: any ) => void;
 * @param error - error argument
 * @param result - value used to update the collection
 */
-type Callback = Unary | Binary;
+type Next<U> = UnaryNext | BinaryNext<U>;
 
 /**
 * Function invoked for each element in a collection.
@@ -100,7 +99,7 @@ type Callback = Unary | Binary;
 * @param value - collection value
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type BinaryFcn = ( value: any, next: Callback ) => void;
+type BinaryFcn<T, U, V> = ( this: V, value: T, next: Next<U> ) => void;
 
 /**
 * Function invoked for each element in a collection.
@@ -109,7 +108,7 @@ type BinaryFcn = ( value: any, next: Callback ) => void;
 * @param index - collection index
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type TertiaryFcn = ( value: any, index: number, next: Callback ) => void;
+type TernaryFcn<T, U, V> = ( this: V, value: T, index: number, next: Next<U> ) => void;
 
 /**
 * Function invoked for each element in a collection.
@@ -119,7 +118,7 @@ type TertiaryFcn = ( value: any, index: number, next: Callback ) => void;
 * @param collection - input collection
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type QuaternaryFcn = ( value: any, index: number, collection: Collection, next: Callback ) => void; // tslint-disable-line max-line-length
+type QuaternaryFcn<T, U, V> = ( this: V, value: T, index: number, collection: Collection<U>, next: Next<U> ) => void;
 
 /**
 * Function invoked for each element in a collection.
@@ -129,7 +128,7 @@ type QuaternaryFcn = ( value: any, index: number, collection: Collection, next:
 * @param collection - input collection
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type Fcn = BinaryFcn | TertiaryFcn | QuaternaryFcn;
+type Fcn<T, U, V> = BinaryFcn<T, U, V> | TernaryFcn<T, U, V> | QuaternaryFcn<T, U, V>;
 
 /**
 * Invokes the provided function for each element in a collection and updates a collection in-place.
@@ -137,7 +136,7 @@ type Fcn = BinaryFcn | TertiaryFcn | QuaternaryFcn;
 * @param collection - input collection
 * @param done - function to invoke upon completion
 */
-type FactoryFunction = ( collection: Collection, done: DoneCallback ) => void;
+type FactoryFunction<T, U> = ( collection: Collection<T>, done: Callback<U> ) => void;
 
 /**
 * Interface for `inmapRightAsync`.
@@ -151,7 +150,6 @@ interface InMapRightAsync {
 	* -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 	* -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 	*
-	*
 	* @param collection - input collection
 	* @param options - function options
 	* @param options.thisArg - execution context
@@ -192,7 +190,7 @@ interface InMapRightAsync {
 	*
 	* inmapRightAsync( files, {}, read, done );
 	*/
-	( collection: Collection, options: Options, fcn: Fcn, done: DoneCallback ): void; // tslint-disable-line max-line-length
+	<T = unknown, U = unknown, V = unknown>( collection: Collection<T>, options: Options<T, U, V>, fcn: Fcn<T, U, V>, done: Callback<U> ): void;
 
 	/**
 	* Invokes a function once for each element in a collection and updates a collection in-place.
@@ -202,7 +200,6 @@ interface InMapRightAsync {
 	* -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 	* -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 	*
-	*
 	* @param collection - input collection
 	* @param fcn - function to invoke for each element in a collection
 	* @param done - function to invoke upon completion
@@ -238,7 +235,7 @@ interface InMapRightAsync {
 	*
 	* inmapRightAsync( files, read, done );
 	*/
-	( collection: Collection, fcn: Fcn, done: DoneCallback ): void;
+	<T = unknown, U = unknown, V = unknown>( collection: Collection<T>, fcn: Fcn<T, U, V>, done: Callback<U> ): void; // tslint:disable-line:no-unnecessary-generics
 
 	/**
 	* Returns a function to invoke a function once for each element in a collection and to update the collection in-place.
@@ -248,7 +245,6 @@ interface InMapRightAsync {
 	* -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 	* -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 	*
-	*
 	* @param options - function options
 	* @param options.thisArg - execution context
 	* @param options.limit - maximum number of pending invocations at any one time
@@ -298,7 +294,7 @@ interface InMapRightAsync {
 	* // Run `read` for each element in `files`:
 	* inmapRightAsync( files, done );
 	*/
-	factory( options: Options, fcn: Fcn ): FactoryFunction;
+	factory<T = unknown, U = unknown, V = unknown>( options: Options<T, U, V>, fcn: Fcn<T, U, V> ): FactoryFunction<T, U>;
 
 	/**
 	* Returns a function to invoke a function once for each element in a collection and to update the collection in-place.
@@ -308,7 +304,6 @@ interface InMapRightAsync {
 	* -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 	* -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 	*
-	*
 	* @param fcn - function to invoke for each element in a collection
 	* @throws must provide valid options
 	* @returns function which invokes the provided function once for each element in a collection
@@ -350,7 +345,7 @@ interface InMapRightAsync {
 	* // Run `read` for each element in `files`:
 	* inmapRightAsync( files, done );
 	*/
-	factory( fcn: Fcn ): FactoryFunction;
+	factory<T = unknown, U = unknown, V = unknown>( fcn: Fcn<T, U, V> ): FactoryFunction<T, U>; // tslint:disable-line:no-unnecessary-generics
 }
 
 /**
@@ -361,7 +356,6 @@ interface InMapRightAsync {
 * -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 * -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 *
-*
 * @param collection - input collection
 * @param options - function options
 * @param options.thisArg - execution context

package/lib/factory.js

@@ -22,6 +22,7 @@
 
 var isFunction = require( '@stdlib/assert-is-function' );
 var isCollection = require( '@stdlib/assert-is-collection' );
+var format = require( '@stdlib/string-format' );
 var PINF = require( '@stdlib/constants-float64-pinf' );
 var validate = require( './validate.js' );
 var limit = require( './limit.js' );
@@ -37,7 +38,6 @@ var limit = require( './limit.js' );
 * -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 * -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 *
-*
 * @param {Options} [options] - function options
 * @param {*} [options.thisArg] - execution context
 * @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time
@@ -105,7 +105,7 @@ function factory( options, fcn ) {
 		f = options;
 	}
 	if ( !isFunction( f ) ) {
-		throw new TypeError( 'invalid argument. Last argument must be a function. Value: `'+f+'`.' );
+		throw new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', f ) );
 	}
 	if ( opts.series ) {
 		opts.limit = 1;
@@ -126,10 +126,10 @@ function factory( options, fcn ) {
 	*/
 	function inmapRightAsync( collection, done ) {
 		if ( !isCollection( collection ) ) {
-			throw new TypeError( 'invalid argument. First argument must be a collection. Value: `'+collection+'.`' );
+			throw new TypeError( format( 'invalid argument. First argument must be a collection. Value: `%s`.', collection ) );
 		}
 		if ( !isFunction( done ) ) {
-			throw new TypeError( 'invalid argument. Last argument must be a function. Value: `'+done+'`.' );
+			throw new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', done ) );
 		}
 		return limit( collection, opts, f, clbk );
 

package/lib/index.js

@@ -60,15 +60,15 @@
 // MODULES //
 
 var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var inmapRightAsync = require( './inmap_right.js' );
+var main = require( './main.js' );
 var factory = require( './factory.js' );
 
 
 // MAIN //
 
-setReadOnly( inmapRightAsync, 'factory', factory );
+setReadOnly( main, 'factory', factory );
 
 
 // EXPORTS //
 
-module.exports = inmapRightAsync;
+module.exports = main;

package/lib/limit.js

@@ -70,7 +70,7 @@ function limit( collection, opts, fcn, done ) {
 	for ( i = 0; i < lim; i++ ) {
 		// This guard is necessary to protect against synchronous functions which exhaust all collection elements...
 		if ( idx > 0 ) {
-			next(); // eslint-disable-line callback-return
+			next(); // eslint-disable-line node/callback-return
 		}
 	}
 	/**

package/lib/{inmap_right.js → main.js}

@@ -33,7 +33,6 @@ var factory = require( './factory.js' );
 * -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 * -   This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
 *
-*
 * @param {Collection} collection - input collection
 * @param {Options} [options] - function options
 * @param {*} [options.thisArg] - execution context

package/lib/validate.js

@@ -24,6 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' );
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive;
 var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive;
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -53,7 +54,7 @@ var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimit
 */
 function validate( opts, options ) {
 	if ( !isObject( options ) ) {
-		return new TypeError( 'invalid argument. Options must be an object. Value: `' + options + '`.' );
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'thisArg' ) ) {
 		opts.thisArg = options.thisArg;
@@ -61,13 +62,13 @@ function validate( opts, options ) {
 	if ( hasOwnProp( options, 'series' ) ) {
 		opts.series = options.series;
 		if ( !isBoolean( opts.series ) ) {
-			return new TypeError( 'invalid option. `series` option must be a boolean primitive. Option: `' + opts.series + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'series', opts.series ) );
 		}
 	}
 	if ( hasOwnProp( options, 'limit' ) ) {
 		opts.limit = options.limit;
 		if ( !isPositiveInteger( opts.limit ) ) {
-			return new TypeError( 'invalid option. `limit` option must be a positive integer. Option: `' + opts.limit + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a positive integer. Option: `%s`.', 'limit', opts.limit ) );
 		}
 	}
 	return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-async-inmap-right",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Invoke a function for each element in a collection and update the collection in-place, iterating from right to left.",
   "license": "Apache-2.0",
   "author": {
@@ -37,25 +37,27 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.0.x",
-    "@stdlib/assert-is-boolean": "^0.0.x",
-    "@stdlib/assert-is-collection": "^0.0.x",
-    "@stdlib/assert-is-function": "^0.0.x",
-    "@stdlib/assert-is-plain-object": "^0.0.x",
-    "@stdlib/assert-is-positive-integer": "^0.0.x",
-    "@stdlib/constants-float64-pinf": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
-    "debug": "^2.6.9"
+    "@stdlib/assert-has-own-property": "^0.1.0",
+    "@stdlib/assert-is-boolean": "^0.1.0",
+    "@stdlib/assert-is-collection": "^0.1.0",
+    "@stdlib/assert-is-function": "^0.1.0",
+    "@stdlib/assert-is-plain-object": "^0.1.0",
+    "@stdlib/assert-is-positive-integer": "^0.1.0",
+    "@stdlib/constants-float64-pinf": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/types": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
+    "debug": "^2.6.9",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/constants-float64-eps": "^0.0.x",
-    "@stdlib/fs-read-file": "^0.0.x",
-    "@stdlib/utils-noop": "^0.0.x",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/constants-float64-eps": "^0.1.0",
+    "@stdlib/fs-read-file": "^0.1.0",
+    "@stdlib/utils-noop": "^0.1.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -94,7 +96,7 @@
     "async"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,209 +0,0 @@
-
-{{alias}}( collection, [options,] fcn, done )
-    Invokes a function once for each element in a collection and updates a
-    collection in-place, iterating from right to left.
-
-    When invoked, `fcn` is provided a maximum of four arguments:
-
-    - `value`: collection value
-    - `index`: collection index
-    - `collection`: the input collection
-    - `next`: a callback to be invoked after processing a collection `value`
-
-    The actual number of provided arguments depends on function length. If `fcn`
-    accepts two arguments, `fcn` is provided:
-
-    - `value`
-    - `next`
-
-    If `fcn` accepts three arguments, `fcn` is provided:
-
-    - `value`
-    - `index`
-    - `next`
-
-    For every other `fcn` signature, `fcn` is provided all four arguments.
-
-    The `next` callback accepts two arguments:
-
-    - `error`: error argument
-    - `result`: value used to update the collection
-
-    If a provided function calls the `next` callback with a truthy `error`
-    argument, the function suspends execution and immediately calls the `done`
-    callback for subsequent `error` handling. Note, however, that the function
-    may have mutated an input collection during prior invocations, resulting in
-    a partially mutated collection.
-
-    Execution is *not* guaranteed to be asynchronous. To guarantee asynchrony,
-    wrap the `done` callback in a function which either executes at the end of
-    the current stack (e.g., `nextTick`) or during a subsequent turn of the
-    event loop (e.g., `setImmediate`, `setTimeout`).
-
-    The function does not support dynamic collection resizing.
-
-    The function does not skip `undefined` elements.
-
-    Parameters
-    ----------
-    collection: Array|TypedArray|Object
-        Input collection over which to iterate. If provided an object, the
-        object must be array-like (excluding strings and functions).
-
-    options: Object (optional)
-        Function options.
-
-    options.limit: integer (optional)
-        Maximum number of pending invocations. Default: Infinity.
-
-    options.series: boolean (optional)
-        Boolean indicating whether to process each collection element
-        sequentially. Default: false.
-
-    options.thisArg: any (optional)
-        Execution context.
-
-    fcn: Function
-        The function to invoke for each element in a collection.
-
-    done: Function
-        A callback invoked either upon processing all collection elements or
-        upon encountering an error.
-
-    Examples
-    --------
-    // Basic usage:
-    > function fcn( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, value*index );
-    ...     }
-    ... };
-    > function done( error, collection ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( collection === arr );
-    ...     console.log( collection );
-    ... };
-    > var arr = [ 1000, 2500, 3000 ];
-    > {{alias}}( arr, fcn, done )
-    1000
-    2500
-    3000
-    true
-    [ 0, 2500, 6000 ]
-
-    // Limit number of concurrent invocations:
-    > function fcn( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, value*index );
-    ...     }
-    ... };
-    > function done( error, collection ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( collection === arr );
-    ...     console.log( collection );
-    ... };
-    > var opts = { 'limit': 2 };
-    > var arr = [ 1000, 2500, 3000 ];
-    > {{alias}}( arr, opts, fcn, done )
-    2500
-    3000
-    1000
-    true
-    [ 0, 2500, 6000 ]
-
-    // Process sequentially:
-    > function fcn( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, value*index );
-    ...     }
-    ... };
-    > function done( error, collection ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( collection === arr );
-    ...     console.log( collection );
-    ... };
-    > var opts = { 'series': true };
-    > var arr = [ 1000, 2500, 3000 ];
-    > {{alias}}( arr, opts, fcn, done )
-    3000
-    2500
-    1000
-    true
-    [ 0, 2500, 6000 ]
-
-
-{{alias}}.factory( [options,] fcn )
-    Returns a function which invokes a function once for each element in a
-    collection and updates a collection in-place, iterating from right to left.
-
-    Parameters
-    ----------
-    options: Object (optional)
-        Function options.
-
-    options.limit: integer (optional)
-        Maximum number of pending invocations. Default: Infinity.
-
-    options.series: boolean (optional)
-        Boolean indicating whether to process each collection element
-        sequentially. Default: false.
-
-    options.thisArg: any (optional)
-        Execution context.
-
-    fcn: Function
-        The function to invoke for each element in a collection.
-
-    Returns
-    -------
-    out: Function
-        A function which invokes a function for each element in a collection.
-
-    Examples
-    --------
-    > function fcn( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, value*index );
-    ...     }
-    ... };
-    > var opts = { 'series': true };
-    > var f = {{alias}}.factory( opts, fcn );
-    > function done( error, collection ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( collection === arr );
-    ...     console.log( collection );
-    ... };
-    > var arr = [ 1000, 2500, 3000 ];
-    > f( arr, done )
-    3000
-    2500
-    1000
-    true
-    [ 0, 2500, 6000 ]
-    > arr = [ 1000, 1500, 2000 ];
-    > f( arr, done )
-    2000
-    1500
-    1000
-    true
-    [ 0, 1500, 4000 ]
-
-    See Also
-    --------
-