@stdlib/utils-async-group-by 0.2.1 → 0.2.3

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -505,7 +505,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -518,8 +518,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/utils-async-group-by.svg
 [npm-url]: https://npmjs.org/package/@stdlib/utils-async-group-by
 
-[test-image]: https://github.com/stdlib-js/utils-async-group-by/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/utils-async-group-by/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/utils-async-group-by/actions/workflows/test.yml/badge.svg?branch=v0.2.3
+[test-url]: https://github.com/stdlib-js/utils-async-group-by/actions/workflows/test.yml?query=branch:v0.2.3
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-async-group-by/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/utils-async-group-by?branch=main
@@ -531,8 +531,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/docs/types/index.d.ts

@@ -85,7 +85,7 @@ interface ValuesResults<T> {
 /**
 * Interface describing group results when returning indices.
 */
-interface IndicesResults<T> {
+interface IndicesResults {
 	/**
 	* Results for an individual group.
 	*/
@@ -128,7 +128,7 @@ type ValuesBinary<T> = ( error: Error | null, result: ValuesResults<T> ) => void
 * @param error - encountered error or null
 * @param result - group results
 */
-type IndicesBinary<T> = ( error: Error | null, result: IndicesResults<T> ) => void;
+type IndicesBinary = ( error: Error | null, result: IndicesResults ) => void;
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.
@@ -152,7 +152,7 @@ type ValuesCallback<T> = Nullary | Unary | ValuesBinary<T>;
 * @param error - encountered error or null
 * @param result - group results
 */
-type IndicesCallback<T> = Nullary | Unary | IndicesBinary<T>;
+type IndicesCallback = Nullary | Unary | IndicesBinary;
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.
@@ -241,7 +241,7 @@ type ValuesFactoryFunction<T> = ( collection: Collection<T>, done: ValuesCallbac
 * @param collection - input collection
 * @param done - function to invoke upon completion
 */
-type IndicesFactoryFunction<T> = ( collection: Collection<T>, done: IndicesCallback<T> ) => void;
+type IndicesFactoryFunction<T> = ( collection: Collection<T>, done: IndicesCallback ) => void;
 
 /**
 * Invokes an indicator function for each element in a collection.
@@ -303,7 +303,7 @@ interface GroupByAsync {
 	*
 	* groupByAsync( files, {}, indicator, done );
 	*/
-	<T = unknown, V = unknown>( collection: Collection<T>, options: IndicesOptions<T, V>, indicator: Indicator<T, V>, done: IndicesCallback<T> ): void;
+	<T = unknown, V = unknown>( collection: Collection<T>, options: IndicesOptions<T, V>, indicator: Indicator<T, V>, done: IndicesCallback ): void;
 
 	/**
 	* Groups values according to an indicator function.
@@ -487,7 +487,7 @@ interface GroupByAsync {
 	* };
 	*
 	* // Create a `groupByAsync` function which invokes the indicator function for each collection element sequentially:
-	* var groupByAsync = factory( opts, indicator );
+	* var groupBy = groupByAsync.factory( opts, indicator );
 	*
 	* // Create a collection over which to iterate:
 	* var files = [
@@ -504,7 +504,7 @@ interface GroupByAsync {
 	* }
 	*
 	* // Try to read each element in `files`:
-	* groupByAsync( files, done );
+	* groupBy( files, done );
 	*/
 	factory<T = unknown, V = unknown>( options: IndicesOptions<T, V>, indicator: Indicator<T, V> ): IndicesFactoryFunction<T>;
 
@@ -546,7 +546,7 @@ interface GroupByAsync {
 	* };
 	*
 	* // Create a `groupByAsync` function which invokes the indicator function for each collection element sequentially:
-	* var groupByAsync = factory( opts, indicator );
+	* var groupBy = groupByAsync.factory( opts, indicator );
 	*
 	* // Create a collection over which to iterate:
 	* var files = [
@@ -563,7 +563,7 @@ interface GroupByAsync {
 	* }
 	*
 	* // Try to read each element in `files`:
-	* groupByAsync( files, done );
+	* groupBy( files, done );
 	*/
 	factory<T = unknown, V = unknown>( options: IndicesAndValuesOptions<T, V>, indicator: Indicator<T, V> ): IndicesAndValuesFactoryFunction<T>;
 
@@ -605,7 +605,7 @@ interface GroupByAsync {
 	* };
 	*
 	* // Create a `groupByAsync` function which invokes the indicator function for each collection element sequentially:
-	* var groupByAsync = factory( opts, indicator );
+	* var groupBy = groupByAsync.factory( opts, indicator );
 	*
 	* // Create a collection over which to iterate:
 	* var files = [
@@ -622,7 +622,7 @@ interface GroupByAsync {
 	* }
 	*
 	* // Try to read each element in `files`:
-	* groupByAsync( files, done );
+	* groupBy( files, done );
 	*/
 	factory<T = unknown, V = unknown>( options: ValuesOptions<T, V> | BaseOptions<T, V>, indicator: Indicator<T, V> ): ValuesFactoryFunction<T>;
 
@@ -654,7 +654,7 @@ interface GroupByAsync {
 	* }
 	*
 	* // Create a `groupByAsync` function which invokes the indicator function for each collection element sequentially:
-	* var groupByAsync = factory( indicator );
+	* var groupBy = groupByAsync.factory( indicator );
 	*
 	* // Create a collection over which to iterate:
 	* var files = [
@@ -671,7 +671,7 @@ interface GroupByAsync {
 	* }
 	*
 	* // Try to read each element in `files`:
-	* groupByAsync( files, done );
+	* groupBy( files, done );
 	*/
 	factory<T = unknown, V = unknown>( indicator: Indicator<T, V> ): ValuesFactoryFunction<T>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-async-group-by",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Group values according to an indicator function.",
   "license": "Apache-2.0",
   "author": {
@@ -30,17 +30,18 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.2.1",
-    "@stdlib/assert-is-boolean": "^0.2.1",
-    "@stdlib/assert-is-collection": "^0.2.1",
-    "@stdlib/assert-is-function": "^0.2.1",
-    "@stdlib/assert-is-plain-object": "^0.2.1",
-    "@stdlib/assert-is-positive-integer": "^0.2.1",
-    "@stdlib/constants-float64-pinf": "^0.2.1",
-    "@stdlib/string-format": "^0.2.1",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1",
-    "@stdlib/utils-index-of": "^0.2.1",
-    "debug": "^2.6.9"
+    "@stdlib/assert-has-own-property": "^0.2.3",
+    "@stdlib/assert-is-boolean": "^0.2.3",
+    "@stdlib/assert-is-collection": "^0.2.3",
+    "@stdlib/assert-is-function": "^0.2.3",
+    "@stdlib/assert-is-plain-object": "^0.2.3",
+    "@stdlib/assert-is-positive-integer": "^0.2.3",
+    "@stdlib/constants-float64-pinf": "^0.2.3",
+    "@stdlib/string-format": "^0.2.3",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3",
+    "@stdlib/utils-index-of": "^0.2.3",
+    "debug": "^2.6.9",
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.3"
   },
   "devDependencies": {},
   "engines": {