@stdlib/utils-async-every-by 0.0.8 → 0.2.0

package/docs/types/index.d.ts

@@ -16,16 +16,16 @@
 * 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, V> {
 	/**
 	* The maximum number of pending invocations at any one time.
 	*/
@@ -39,7 +39,7 @@ interface Options {
 	/**
 	* Execution context.
 	*/
-	thisArg?: any;
+	thisArg?: ThisParameterType<Predicate<T, V>>;
 }
 
 /**
@@ -76,7 +76,7 @@ type Callback = Nullary | Unary | Binary;
 * @param value - collection value
 * @param next - callback which should be called once the predicate function has finished processing a collection value
 */
-type BinaryPredicate = ( value: any, next: Callback ) => void;
+type BinaryPredicate<T, V> = ( this: V, value: T, next: Callback ) => void;
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -85,7 +85,7 @@ type BinaryPredicate = ( value: any, next: Callback ) => void;
 * @param index - collection index
 * @param next - callback which should be called once the `predicate` function has finished processing a collection `value`
 */
-type TernaryPredicate = ( value: any, index: number, next: Callback ) => void;
+type TernaryPredicate<T, V> = ( this: V, value: T, index: number, next: Callback ) => void;
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -95,7 +95,7 @@ type TernaryPredicate = ( value: any, index: number, next: Callback ) => void;
 * @param collection - input collection
 * @param next - callback which should be called once the `predicate` function has finished processing a collection `value`
 */
-type QuaternaryPredicate = ( value: any, index: number, collection: Collection, next: Callback ) => void; // tslint-disable-line max-line-length
+type QuaternaryPredicate<T, V> = ( this: V, value: T, index: number, collection: Collection<T>, next: Callback ) => void;
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -105,15 +105,15 @@ type QuaternaryPredicate = ( value: any, index: number, collection: Collection,
 * @param collection - input collection
 * @param next - callback which should be called once the `predicate` function has finished processing a collection `value`
 */
-type Predicate = BinaryPredicate | TernaryPredicate | QuaternaryPredicate;
+type Predicate<T, V> = BinaryPredicate<T, V> | TernaryPredicate<T, V> | QuaternaryPredicate<T, V>;
 
 /**
-* Tests whether all elements in a collection pass a test implemented by a predicate function.
+* Tests whether all elements in a collection passes a test implemented by a predicate function.
 *
 * @param collection - input collection
 * @param done - function to invoke upon completion
 */
-type FactoryFunction = ( collection: Collection, done: Callback ) => void;
+type FactoryFunction<T> = ( collection: Collection<T>, done: Callback ) => void;
 
 /**
 * Interface for `everyByAsync`.
@@ -127,7 +127,6 @@ interface EveryByAsync {
 	* -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 	* -   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
@@ -138,7 +137,7 @@ interface EveryByAsync {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -172,7 +171,7 @@ interface EveryByAsync {
 	*
 	* everyByAsync( files, predicate, done );
 	*/
-	( collection: Collection, options: Options, predicate: Predicate, done: Callback ): void; // tslint-disable-line max-line-length
+	<T = unknown, V = unknown>( collection: Collection<T>, options: Options<T, V>, predicate: Predicate<T, V>, done: Callback ): void;
 
 	/**
 	* Tests whether all elements in a collection pass a test implemented by a predicate function.
@@ -182,14 +181,13 @@ interface EveryByAsync {
 	* -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 	* -   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 predicate - predicate function to invoke for each element in a collection
 	* @param done - function to invoke upon completion
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -223,7 +221,7 @@ interface EveryByAsync {
 	*
 	* everyByAsync( files, predicate, done );
 	*/
-	( collection: Collection, predicate: Predicate, done: Callback ): void;
+	<T = unknown, V = unknown>( collection: Collection<T>, predicate: Predicate<T, V>, done: Callback ): void;
 
 	/**
 	* Returns a function for testing whether all elements in a collection pass a test implemented by a predicate function.
@@ -233,7 +231,6 @@ interface EveryByAsync {
 	* -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 	* -   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
@@ -243,7 +240,7 @@ interface EveryByAsync {
 	* @returns function which invokes the predicate function once for each element in a collection
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function predicate( file, next ) {
 	*     var opts = {
@@ -287,7 +284,7 @@ interface EveryByAsync {
 	* // Try to read each element in `files`:
 	* everyByAsync( files, done );
 	*/
-	factory( options: Options, predicate: Predicate ): FactoryFunction;
+	factory<T = unknown, V = unknown>( options: Options<T, V>, predicate: Predicate<T, V> ): FactoryFunction<T>;
 
 	/**
 	* Returns a function for testing whether all elements in a collection pass a test implemented by a predicate function.
@@ -297,13 +294,12 @@ interface EveryByAsync {
 	* -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 	* -   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 predicate - predicate function to invoke for each element in a collection
 	* @throws must provide valid options
 	* @returns function which invokes the predicate function once for each element in a collection
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function predicate( file, next ) {
 	*     var opts = {
@@ -347,7 +343,7 @@ interface EveryByAsync {
 	* // Try to read each element in `files`:
 	* everyByAsync( files, done );
 	*/
-	factory( predicate: Predicate ): FactoryFunction;
+	factory<T = unknown, V = unknown>( predicate: Predicate<T, V> ): FactoryFunction<T>;
 }
 
 /**
@@ -358,7 +354,6 @@ interface EveryByAsync {
 * -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 * -   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
@@ -369,7 +364,7 @@ interface EveryByAsync {
 * @throws must provide valid options
 *
 * @example
-* var readFile = require( `@stdlib/fs/read-file` );
+* var readFile = require( '@stdlib/fs-read-file' );
 *
 * function done( error, bool ) {
 *     if ( error ) {

package/lib/factory.js

@@ -23,6 +23,7 @@
 var isFunction = require( '@stdlib/assert-is-function' );
 var isCollection = require( '@stdlib/assert-is-collection' );
 var PINF = require( '@stdlib/constants-float64-pinf' );
+var format = require( '@stdlib/string-format' );
 var validate = require( './validate.js' );
 var limit = require( './limit.js' );
 
@@ -37,7 +38,6 @@ var limit = require( './limit.js' );
 * -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 * -   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
@@ -109,7 +109,7 @@ function factory( options, predicate ) {
 		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;
@@ -130,10 +130,10 @@ function factory( options, predicate ) {
 	*/
 	function everyByAsync( 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

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

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

@@ -33,7 +33,6 @@ var factory = require( './factory.js' );
 * -   If a predicate function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
 * -   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-every-by",
-  "version": "0.0.8",
+  "version": "0.2.0",
   "description": "Test whether all elements in a collection pass a test implemented by a predicate function.",
   "license": "Apache-2.0",
   "author": {
@@ -37,24 +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.1",
+    "@stdlib/assert-is-boolean": "^0.2.0",
+    "@stdlib/assert-is-collection": "^0.2.0",
+    "@stdlib/assert-is-function": "^0.2.0",
+    "@stdlib/assert-is-plain-object": "^0.2.0",
+    "@stdlib/assert-is-positive-integer": "^0.2.0",
+    "@stdlib/constants-float64-pinf": "^0.2.0",
+    "@stdlib/string-format": "^0.2.0",
+    "@stdlib/types": "^0.3.1",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0",
+    "debug": "^2.6.9",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.1"
   },
   "devDependencies": {
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/fs-read-file": "^0.0.x",
-    "@stdlib/utils-noop": "^0.0.x",
+    "@stdlib/fs-read-file": "^0.1.1",
+    "@stdlib/utils-noop": "^0.2.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",
+    "@stdlib/bench-harness": "^0.1.2",
+    "@stdlib/bench": "^0.3.1"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -92,7 +95,7 @@
     "validate"
   ],
   "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,] predicate, done )
-    Tests whether all elements in a collection pass a test implemented by a
-    predicate function.
-
-    When invoked, the predicate function 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 the
-    predicate function accepts two arguments, the predicate function is
-    provided:
-
-    - `value`
-    - `next`
-
-    If the predicate function accepts three arguments, the predicate function is
-    provided:
-
-    - `value`
-    - `index`
-    - `next`
-
-    For every other predicate function signature, the predicate function is
-    provided all four arguments.
-
-    The `next` callback takes two arguments:
-
-    - `error`: error argument
-    - `result`: test result
-
-    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.
-
-    The function immediately returns upon encountering a non-truthy `result`
-    value and calls the `done` callback with `null` as the first argument and
-    `false` as the second argument.
-
-    If all elements succeed, the function calls the `done` callback with `null`
-    as the first argument and `true` as the second argument.
-
-    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.
-
-    predicate: Function
-        The test 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 predicate( value, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, true );
-    ...     }
-    ... };
-    > function done( error, bool ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( bool );
-    ... };
-    > var arr = [ 3000, 2500, 1000 ];
-    > {{alias}}( arr, predicate, done )
-    1000
-    2500
-    3000
-    true
-
-    // Limit number of concurrent invocations:
-    > function predicate( value, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, true );
-    ...     }
-    ... };
-    > function done( error, bool ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( bool );
-    ... };
-    > var opts = { 'limit': 2 };
-    > var arr = [ 3000, 2500, 1000 ];
-    > {{alias}}( arr, opts, predicate, done )
-    2500
-    3000
-    1000
-    true
-
-    // Process sequentially:
-    > function predicate( value, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, true );
-    ...     }
-    ... };
-    > function done( error, bool ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( bool );
-    ... };
-    > var opts = { 'series': true };
-    > var arr = [ 3000, 2500, 1000 ];
-    > {{alias}}( arr, opts, predicate, done )
-    3000
-    2500
-    1000
-    true
-
-
-{{alias}}.factory( [options,] predicate )
-    Returns a function which tests whether all elements in a collection pass a
-    test implemented by a predicate function.
-
-    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.
-
-    predicate: Function
-        The test function to invoke for each element in a collection.
-
-    Returns
-    -------
-    out: Function
-        A function which tests each element in a collection.
-
-    Examples
-    --------
-    > function predicate( value, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, true );
-    ...     }
-    ... };
-    > var opts = { 'series': true };
-    > var f = {{alias}}.factory( opts, predicate );
-    > function done( error, bool ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( bool );
-    ... };
-    > var arr = [ 3000, 2500, 1000 ];
-    > f( arr, done )
-    3000
-    2500
-    1000
-    true
-    > arr = [ 2000, 1500, 1000 ];
-    > f( arr, done )
-    2000
-    1500
-    1000
-    true
-
-    See Also
-    --------
-