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

package/lib/validate.js

@@ -25,6 +25,7 @@ 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 indexOf = require( '@stdlib/utils-index-of' );
+var format = require( '@stdlib/string-format' );
 
 
 // VARIABLES //
@@ -61,7 +62,7 @@ var returns = [ 'values', 'indices', '*' ];
 */
 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;
@@ -69,19 +70,19 @@ 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 ) );
 		}
 	}
 	if ( hasOwnProp( options, 'returns' ) ) {
 		opts.returns = options.returns;
 		if ( indexOf( returns, opts.returns ) === -1 ) {
-			return new TypeError( 'invalid option. `returns` option must be one of the following: "' + returns.join( '", "' ) + '". Option: `' + opts.returns + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'returns', returns.join( '", "' ), opts.returns ) );
 		}
 	}
 	return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-async-group-by",
-  "version": "0.0.8",
+  "version": "0.2.0",
   "description": "Group values according to an indicator function.",
   "license": "Apache-2.0",
   "author": {
@@ -37,25 +37,28 @@
     "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",
-    "@stdlib/utils-index-of": "^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",
+    "@stdlib/utils-index-of": "^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",
@@ -94,7 +97,7 @@
     "array-like"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,232 +0,0 @@
-
-{{alias}}( collection, [options,] indicator, done )
-    Groups values according to an indicator function.
-
-    When invoked, the indicator 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
-    indicator function accepts two arguments, the indicator function is
-    provided:
-
-    - `value`
-    - `next`
-
-    If the indicator function accepts three arguments, the indicator function is
-    provided:
-
-    - `value`
-    - `index`
-    - `next`
-
-    For every other indicator function signature, the indicator function is
-    provided all four arguments.
-
-    The `next` callback takes two arguments:
-
-    - `error`: error argument
-    - `group`: value group
-
-    If an indicator function calls the `next` callback with a truthy `error`
-    argument, the function suspends execution and immediately calls the `done`
-    callback for subsequent `error` handling.
-
-    If provided an empty collection, the function calls the `done` callback with
-    an empty object as the second argument.
-
-    The `group` returned by an indicator function should be a value which can be
-    serialized as an object key.
-
-    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.returns: string (optional)
-        If `values`, values are returned; if `indices`, indices are returned; if
-        `*`, both indices and values are returned. Default: 'values'.
-
-    options.thisArg: any (optional)
-        Execution context.
-
-    indicator: Function
-        Indicator function specifying which group an element in the input
-        collection belongs to.
-
-    done: Function
-        A callback invoked either upon processing all collection elements or
-        upon encountering an error.
-
-    Examples
-    --------
-    // Basic usage:
-    > function indicator( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, ( index%2 === 0 ) );
-    ...     }
-    ... };
-    > function done( error, result ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( result );
-    ... };
-    > var arr = [ 3000, 2500, 1000 ];
-    > {{alias}}( arr, indicator, done )
-    1000
-    2500
-    3000
-    { "true": [ 1000, 3000 ], "false": [ 2500 ] }
-
-    // Output group results as indices:
-    > var opts = { 'returns': 'indices' };
-    > {{alias}}( arr, opts, indicator, done )
-    1000
-    2500
-    3000
-    { "true": [ 2, 0 ], "false": [ 1 ] }
-
-    // Output group results as index-value pairs:
-    > opts = { 'returns': '*' };
-    > {{alias}}( arr, opts, indicator, done )
-    1000
-    2500
-    3000
-    { "true": [ [ 2, 1000 ], [ 0, 3000 ] ], "false": [ [ 1, 2500 ] ] }
-
-    // Limit number of concurrent invocations:
-    > function indicator( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, ( index%2 === 0 ) );
-    ...     }
-    ... };
-    > function done( error, result ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( result );
-    ... };
-    > var opts = { 'limit': 2 };
-    > var arr = [ 3000, 2500, 1000 ];
-    > {{alias}}( arr, opts, indicator, done )
-    2500
-    3000
-    1000
-    { "true": [ 3000, 1000 ], "false": [ 2500 ] }
-
-    // Process sequentially:
-    > function indicator( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, ( index%2 === 0 ) );
-    ...     }
-    ... };
-    > function done( error, result ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( result );
-    ... };
-    > var opts = { 'series': true };
-    > var arr = [ 3000, 2500, 1000 ];
-    > {{alias}}( arr, opts, indicator, done )
-    3000
-    2500
-    1000
-    { "true": [ 3000, 1000 ], "false": [ 2500 ] }
-
-
-{{alias}}.factory( [options,] indicator )
-    Returns a function which groups values according to an indicator 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.returns: string (optional)
-        If `values`, values are returned; if `indices`, indices are returned; if
-        `*`, both indices and values are returned. Default: 'values'.
-
-    options.thisArg: any (optional)
-        Execution context.
-
-    indicator: Function
-        Indicator function specifying which group an element in the input
-        collection belongs to.
-
-    Returns
-    -------
-    out: Function
-        A group-by function.
-
-    Examples
-    --------
-    > function indicator( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, ( index%2 === 0 ) );
-    ...     }
-    ... };
-    > var opts = { 'series': true };
-    > var f = {{alias}}.factory( opts, indicator );
-    > function done( error, result ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( result );
-    ... };
-    > var arr = [ 3000, 2500, 1000 ];
-    > f( arr, done )
-    3000
-    2500
-    1000
-    { "true": [ 3000, 1000 ], "false": [ 2500 ] }
-    > arr = [ 2000, 1500, 1000 ];
-    > f( arr, done )
-    2000
-    1500
-    1000
-    { "true": [ 2000, 1000 ], "false": [ 1500 ] }
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,201 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2021 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 groupByAsync = require( './index' );
-
-const indicator = ( value: number, next: Function ) => {
-	next( null, ( value > 2000 ) );
-};
-
-const done = ( error: Error | null, result: any ) => {
-	if ( error ) {
-		throw error;
-	}
-	if ( result === void 0 ) {
-		throw new Error( '`result` is missing.' );
-	}
-};
-
-
-// TESTS //
-
-// The function returns void...
-{
-	groupByAsync( [ 3000, 2500, 1000 ], indicator, done ); // $ExpectType void
-}
-
-// The compiler throws an error if the function is provided a first argument which is not a collection...
-{
-	groupByAsync( 2, indicator, done ); // $ExpectError
-	groupByAsync( false, indicator, done ); // $ExpectError
-	groupByAsync( true, indicator, done ); // $ExpectError
-	groupByAsync( {}, indicator, done ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an indicator argument which is not an indicator function...
-{
-	groupByAsync( [ 3000, 2500, 1000 ], 2, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], false, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], true, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], 'abc', done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], {}, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], [], done ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a done callback argument which is not a function having a supported signature...
-{
-	groupByAsync( [ 3000, 2500, 1000 ], indicator, 2 ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], indicator, false ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], indicator, true ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], indicator, 'abc' ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], indicator, {} ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], indicator, [] ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], indicator, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an options argument which is not an object...
-{
-	groupByAsync( [ 3000, 2500, 1000 ], [], indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], 123, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], 'abc', indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], false, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], true, indicator, done ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a `limit` option which is not a number...
-{
-	groupByAsync( [ 3000, 2500, 1000 ], { 'limit': '12' }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'limit': true }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'limit': false }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'limit': {} }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'limit': [] }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'limit': ( x: number ): number => x }, indicator, done ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a `series` option which is not a boolean...
-{
-	groupByAsync( [ 3000, 2500, 1000 ], { 'series': '12' }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'series': 12 }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'series': {} }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'series': [] }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'series': ( x: number ): number => x }, indicator, done ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a `returns` option which is not `values`, `indices`, or `*`...
-{
-	groupByAsync( [ 3000, 2500, 1000 ], { 'returns': 'abc' }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'returns': 12 }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'returns': true }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'returns': false }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'returns': {} }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'returns': [] }, indicator, done ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], { 'returns': ( x: number ): number => x }, indicator, done ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an invalid number of arguments...
-{
-	groupByAsync(); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ] ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], indicator ); // $ExpectError
-	groupByAsync( [ 3000, 2500, 1000 ], {}, indicator, done, {} ); // $ExpectError
-}
-
-// Attached to main export is a `factory` method which returns a function...
-{
-	groupByAsync.factory( indicator ); // $ExpectType FactoryFunction
-	groupByAsync.factory( { 'series': true }, indicator ); // $ExpectType FactoryFunction
-}
-
-// The compiler throws an error if the `factory` method is provided an options argument which is not an object...
-{
-	groupByAsync.factory( [], indicator ); // $ExpectError
-	groupByAsync.factory( 123, indicator ); // $ExpectError
-	groupByAsync.factory( 'abc', indicator ); // $ExpectError
-	groupByAsync.factory( false, indicator ); // $ExpectError
-	groupByAsync.factory( true, indicator ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided a last argument which is not an indicator function...
-{
-	groupByAsync.factory( {} ); // $ExpectError
-	groupByAsync.factory( true ); // $ExpectError
-	groupByAsync.factory( false ); // $ExpectError
-	groupByAsync.factory( {}, 123 ); // $ExpectError
-	groupByAsync.factory( {}, 'abc' ); // $ExpectError
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments...
-{
-	const fcn1 = groupByAsync.factory( indicator );
-	fcn1( 12, done ); // $ExpectError
-	fcn1( true, done ); // $ExpectError
-	fcn1( false, done ); // $ExpectError
-	fcn1( {}, done ); // $ExpectError
-
-	fcn1( [ 3000, 2500, 1000 ], 12 ); // $ExpectError
-	fcn1( [ 3000, 2500, 1000 ], true ); // $ExpectError
-	fcn1( [ 3000, 2500, 1000 ], false ); // $ExpectError
-	fcn1( [ 3000, 2500, 1000 ], '5' ); // $ExpectError
-	fcn1( [ 3000, 2500, 1000 ], {} ); // $ExpectError
-	fcn1( [ 3000, 2500, 1000 ], [] ); // $ExpectError
-	fcn1( [ 3000, 2500, 1000 ], ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments...
-{
-	const fcn1 = groupByAsync.factory( indicator );
-	fcn1(); // $ExpectError
-	fcn1( [ 3000, 2500, 1000 ] ); // $ExpectError
-	fcn1( [ 3000, 2500, 1000 ], done, {} ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided a `limit` option which is not a number...
-{
-	groupByAsync.factory( { 'limit': '12' }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'limit': true }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'limit': false }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'limit': {} }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'limit': [] }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'limit': ( x: number ): number => x }, indicator ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided a `series` option which is not a boolean...
-{
-	groupByAsync.factory( { 'series': '12' }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'series': 12 }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'series': {} }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'series': [] }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'series': ( x: number ): number => x }, indicator ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided a `returns` option which is not `values`, `indices`, or `*`...
-{
-	groupByAsync.factory( { 'returns': 'abc' }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'returns': 12 }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'returns': true }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'returns': false }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'returns': {} }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'returns': [] }, indicator ); // $ExpectError
-	groupByAsync.factory( { 'returns': ( x: number ): number => x }, indicator ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided an invalid number of arguments...
-{
-	groupByAsync.factory(); // $ExpectError
-	groupByAsync.factory( {}, indicator, {} ); // $ExpectError
-}