Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -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: |

.github/workflows/productionize.yml

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

dist/index.d.ts

@@ -4,8 +4,8 @@
 
     When invoked, the indicator function is provided two arguments:
 
-    - `value`: collection value
-    - `index`: collection index
+    - value: collection value
+    - index: collection index
 
     The value returned by an indicator function should be a value which can be
     serialized as an object key.

dist/index.js

@@ -20,32 +20,32 @@
 
 /// <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> {
 	/**
 	* Execution context.
 	*/
-	thisArg?: any;
+	thisArg?: ThisParameterType<Indicator<T>>;
 }
 
 /**
 * Specifies which group an element in the input collection belongs to.
 *
 * @returns object key
 */
-type Nullary = () => string | symbol;
+type Nullary = () => string | symbol | number;
 
 /**
 * Specifies which group an element in the input collection belongs to.
 *
 * @param value - collection value
 * @returns object key
 */
-type Unary = ( value: any ) => string | symbol;
+type Unary<T> = ( value: T ) => string | symbol | number;
 
 /**
 * Specifies which group an element in the input collection belongs to.
@@ -54,7 +54,7 @@ type Unary = ( value: any ) => string | symbol;
 * @param index - collection index
 * @returns object key
 */
-type Binary = ( value: any, index: number ) => string | symbol;
+type Binary<T> = ( value: T, index: number ) => string | symbol | number;
 
 /**
 * Specifies which group an element in the input collection belongs to.
@@ -63,7 +63,17 @@ type Binary = ( value: any, index: number ) => string | symbol;
 * @param index - collection index
 * @returns object key
 */
-type Indicator = Nullary | Unary | Binary;
+type Indicator<T> = Nullary | Unary<T> | Binary<T>;
+
+/**
+* Interface describing returned results.
+*/
+interface Results<T> {
+	/**
+	* Object properties.
+	*/
+	[key: string | symbol | number]: T;
+}
 
 /**
 * Groups values according to an indicator function and returns group counts.
@@ -92,7 +102,7 @@ type Indicator = Nullary | Unary | Binary;
 * var out = countBy( arr, indicator );
 * // returns { 'b': 3, 'f': 1 }
 */
-declare function countBy( collection: Collection, indicator: Indicator ): any;
+declare function countBy<T = unknown>( collection: Collection<T>, indicator: Indicator<T> ): Results<T>;
 
 /**
 * Groups values according to an indicator function and returns group counts.
@@ -123,7 +133,7 @@ declare function countBy( collection: Collection, indicator: Indicator ): any;
 * var out = countBy( arr, indicator );
 * // returns { 'b': 3, 'f': 1 }
 */
-declare function countBy( collection: Collection, options: Options, indicator: Indicator ): any; // tslint-disable-line max-line-length
+declare function countBy<T = unknown>( collection: Collection<T>, options: Options<T>, indicator: Indicator<T> ): Results<T>;
 
 
 // EXPORTS //

dist/index.js.map

@@ -18,19 +18,28 @@
 
 import countBy = require( './index' );
 
-const indicator = ( v: string ): string => v[ 0 ];
+/**
+* Indicator function.
+*
+* @param v - value
+* @returns indicator
+*/
+function indicator( v: string ): string {
+	return v[ 0 ];
+}
 
 
 // TESTS //
 
 // The function returns an object...
 {
-	countBy( [ 'beep', 'boop', 'foo', 'bar' ], indicator ); // $ExpectType any
-	countBy( [], indicator ); // $ExpectType any
+	countBy( [ 'beep', 'boop', 'foo', 'bar' ], indicator ); // $ExpectType Results<string>
+	countBy( [], indicator ); // $ExpectType Results<string>
+
 	const opts = {
 		'thisArg': {}
 	};
-	countBy( [ 'beep', 'boop', 'foo', 'bar' ], opts, indicator ); // $ExpectType any
+	countBy( [ 'beep', 'boop', 'foo', 'bar' ], opts, indicator ); // $ExpectType Results<string>
 }
 
 // The compiler throws an error if the function is provided a first argument which is not a collection...
@@ -43,6 +52,7 @@ const indicator = ( v: string ): string => v[ 0 ];
 // The compiler throws an error if the function is provided a last argument which is not a function...
 {
 	const arr = [ 'beep', 'boop', 'foo', 'bar' ];
+
 	countBy( arr, false ); // $ExpectError
 	countBy( arr, true ); // $ExpectError
 	countBy( arr, 32 ); // $ExpectError
@@ -61,12 +71,14 @@ const indicator = ( v: string ): string => v[ 0 ];
 // The compiler throws an error if the function is provided an options argument which is not an object...
 {
 	const arr = [ 'beep', 'boop', 'foo', 'bar' ];
+
 	countBy( arr, null, indicator ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided an invalid number of arguments...
 {
 	const arr = [ 'beep', 'boop', 'foo', 'bar' ];
+
 	countBy(); // $ExpectError
 	countBy( arr ); // $ExpectError
 	countBy( arr, {}, indicator, 16 ); // $ExpectError