Auto-generated commit

Author: stdlib-bot

.editorconfig

@@ -179,3 +179,8 @@ indent_size = 2
 [*.gypi]
 indent_style = space
 indent_size = 2
+
+# Set properties for citation files:
+[*.{cff,cff.txt}]
+indent_style = space
+indent_size = 2

.github/workflows/productionize.yml

@@ -82,21 +82,6 @@ jobs:
         id: transform-error-messages
         uses: stdlib-js/transform-errors-action@main
 
-      # Format error messages:
-      - name: 'Replace double quotes with single quotes in rewritten format string error messages'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \;
-
-      # Format string literal error messages:
-      - name: 'Replace double quotes with single quotes in rewritten string literal error messages'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \;
-
-      # Format code:
-      - name: 'Replace double quotes with single quotes in inserted `require` calls'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \;
-
       # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency:
       - name: 'Update dependencies in package.json'
         run: |

CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # countByAsync
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->

dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import countByAsync from '../docs/types/index';
+export = countByAsync;

dist/index.js

@@ -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,109 +39,119 @@ interface Options {
 	/**
 	* Execution context.
 	*/
-	thisArg?: any;
+	thisArg?: ThisParameterType<Indicator<T, V>>;
+}
+
+/**
+* Interface defining a results object.
+*/
+interface Results {
+	/**
+	* Results for an individual group.
+	*/
+	[ key: string ]: number;
 }
 
 /**
 * 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 - encountered error or null
 */
-type DoneUnary = ( error: Error | null ) => void;
+type Unary = ( error: Error | null ) => void;
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.
 *
 * @param error - encountered error or null
 * @param result - counts
 */
-type DoneBinary = ( error: Error | null, result: any ) => void;
+type Binary = ( error: Error | null, result: Results ) => void;
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.
 *
 * @param error - encountered error or null
 * @param result - counts
 */
-type DoneCallback = DoneNullary | DoneUnary | DoneBinary;
+type Callback = Nullary | Unary | Binary;
 
 /**
-* Callback function.
+* Callback function to invoke once the predicate function has finished processing a collection value.
 */
-type Nullary = () => void;
+type NullaryNext = () => void;
 
 /**
-* Callback function.
+* Callback function to invoke once the predicate function has finished processing a collection value.
 *
 * @param error - encountered error or null
 */
-type Unary = ( error: Error | null ) => void;
+type UnaryNext = ( error: Error | null ) => void;
 
 /**
-* Callback function.
+* Callback function to invoke once the predicate function has finished processing a collection value.
 *
 * @param error - encountered error or null
 * @param group - value group
 */
-type Binary = ( error: Error | null, group: string ) => void;
+type BinaryNext = ( error: Error | null, group: string | Symbol | number ) => void;
 
 /**
-* Callback function.
+* Callback function to invoke once the predicate function has finished processing a collection value.
 *
 * @param error - encountered error or null
 * @param group - value group
 */
-type Callback = Nullary | Unary | Binary;
+type Next = NullaryNext | UnaryNext | BinaryNext;
 
 /**
-* Checks whether an element in a collection passes a test.
+* Returns the group to which a collection element belongs.
 *
 * @param value - collection value
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type BinaryIndicator = ( value: any, next: Callback ) => void;
+type BinaryIndicator<T, V> = ( this: V, value: T, next: Next ) => void;
 
 /**
-* Checks whether an element in a collection passes a test.
+* Returns the group to which a collection element belongs.
 *
 * @param value - collection value
 * @param index - collection index
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type TernaryIndicator = ( value: any, index: number, next: Callback ) => void;
+type TernaryIndicator<T, V> = ( this: V, value: T, index: number, next: Next ) => void;
 
 /**
-* Checks whether an element in a collection passes a test.
+* Returns the group to which a collection element belongs.
 *
 * @param value - collection value
 * @param index - collection index
 * @param collection - input collection
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type QuaternaryIndicator = ( value: any, index: number, collection: Collection, next: Callback ) => void; // tslint-disable-line max-line-length
+type QuaternaryIndicator<T, V> = ( this: V, value: T, index: number, collection: Collection<T>, next: Next ) => void;
 
 /**
-* Checks whether an element in a collection passes a test.
+* Returns the group to which a collection element belongs.
 *
 * @param value - collection value
 * @param index - collection index
 * @param collection - input collection
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type Indicator = Unary | BinaryIndicator | TernaryIndicator | QuaternaryIndicator; // tslint-disable-line max-line-length
+type Indicator<T, V> = BinaryIndicator<T, V> | TernaryIndicator<T, V> | QuaternaryIndicator<T, V>;
 
 /**
 * Invokes an indicator function for each element in a collection.
 *
 * @param collection - input collection
 * @param done - function to invoke upon completion
 */
-type FactoryFunction = ( collection: Collection, done: DoneCallback ) => void;
+type FactoryFunction<T> = ( collection: Collection<T>, done: Callback ) => void;
 
 /**
 * Interface for `countByAsync`.
@@ -154,7 +164,6 @@ interface CountByAsync {
 	*
 	* -   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
@@ -195,7 +204,7 @@ interface CountByAsync {
 	*
 	* countByAsync( files, indicator, done );
 	*/
-	( collection: Collection, options: Options, indicator: Indicator, done: DoneCallback ): void; // tslint-disable-line max-line-length
+	<T = unknown, V = unknown>( collection: Collection<T>, options: Options<T, V>, indicator: Indicator<T, V>, done: Callback ): void;
 
 	/**
 	* Groups values according to an indicator function and returns group counts.
@@ -204,7 +213,6 @@ interface CountByAsync {
 	*
 	* -   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 indicator - indicator function specifying which group an element in the input collection belongs to
 	* @param done - function to invoke upon completion
@@ -241,7 +249,7 @@ interface CountByAsync {
 	*
 	* countByAsync( files, indicator, done );
 	*/
-	( collection: Collection, indicator: Indicator, done: DoneCallback ): void;
+	<T = unknown, V = unknown>( collection: Collection<T>, indicator: Indicator<T, V>, done: Callback ): void; // tslint:disable-line:no-unnecessary-generics
 
 	/**
 	* Returns a function for grouping values according to an indicator function and returns group counts.
@@ -250,7 +258,6 @@ interface CountByAsync {
 	*
 	* -   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
@@ -300,7 +307,7 @@ interface CountByAsync {
 	* // Try to read each element in `files`:
 	* countByAsync( files, done );
 	*/
-	factory( options: Options, indicator: Indicator ): FactoryFunction;
+	factory<T = unknown, V = unknown>( options: Options<T, V>, indicator: Indicator<T, V> ): FactoryFunction<T>;
 
 	/**
 	* Returns a function for grouping values according to an indicator function and returns group counts.
@@ -309,7 +316,6 @@ interface CountByAsync {
 	*
 	* -   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
@@ -355,7 +361,7 @@ interface CountByAsync {
 	* // Try to read each element in `files`:
 	* countByAsync( files, done );
 	*/
-	factory( indicator: Indicator ): FactoryFunction;
+	factory<T = unknown, V = unknown>( indicator: Indicator<T, V> ): FactoryFunction<T>; // tslint:disable-line:no-unnecessary-generics
 }
 
 /**
@@ -365,7 +371,6 @@ interface CountByAsync {
 *
 * -   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

dist/index.js.map

@@ -106,8 +106,8 @@ const done = ( error: Error | null, result: any ) => {
 
 // Attached to main export is a `factory` method which returns a function...
 {
-	countByAsync.factory( indicator ); // $ExpectType FactoryFunction
-	countByAsync.factory( { 'series': true }, indicator ); // $ExpectType FactoryFunction
+	countByAsync.factory( indicator ); // $ExpectType FactoryFunction<number>
+	countByAsync.factory( { 'series': true }, indicator ); // $ExpectType FactoryFunction<number>
 }
 
 // The compiler throws an error if the `factory` method is provided an options argument which is not an object...