Release v0.1.0

.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>
+
 # forEach
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -287,8 +298,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/utils-for-each.svg
 [npm-url]: https://npmjs.org/package/@stdlib/utils-for-each
 
-[test-image]: https://github.com/stdlib-js/utils-for-each/actions/workflows/test.yml/badge.svg?branch=main
-[test-url]: https://github.com/stdlib-js/utils-for-each/actions/workflows/test.yml?query=branch:main
+[test-image]: https://github.com/stdlib-js/utils-for-each/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/utils-for-each/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-for-each/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/utils-for-each?branch=main

dist/index.d.ts

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

docs/types/index.d.ts

@@ -16,11 +16,49 @@
 * 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';
+
+/**
+* Function invoked for each collection element.
+*/
+type Nullary<U> = ( this: U ) => void;
+
+/**
+* Function invoked for each collection element.
+*
+* @param value - collection value
+*/
+type Unary<T, U> = ( this: U, value: T ) => void;
+
+/**
+* Function invoked for each collection element.
+*
+* @param value - collection value
+* @param index - collection index
+*/
+type Binary<T, U> = ( this: U, value: T, index: number ) => void;
+
+/**
+* Function invoked for each collection element.
+*
+* @param value - collection value
+* @param index - collection index
+* @param collection - input collection
+*/
+type Ternary<T, U> = ( this: U, value: T, index: number, collection: Collection<T> ) => void;
+
+/**
+* Function invoked for each collection element.
+*
+* @param value - collection value
+* @param index - collection index
+* @param collection - input collection
+*/
+type Callback<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
 
 /**
 * Invokes a function once for each element in a collection.
@@ -47,7 +85,7 @@ import { Collection } from '@stdlib/types/object';
 *
 * forEach( arr, log );
 */
-declare function forEach( collection: Collection, fcn: Function, thisArg?: any ): Collection; // tslint-disable-line max-line-length
+declare function forEach<T = unknown, U = unknown>( collection: Collection<T>, fcn: Callback<T, U>, thisArg?: ThisParameterType<Callback<T, U>> ): Collection<T>;
 
 
 // EXPORTS //

docs/types/test.ts

@@ -18,24 +18,31 @@
 
 import forEach = require( './index' );
 
-const log = ( v: any, index: number ): void => {
-	console.log( `${index}: ${v}` );
-};
+/**
+* Dummy function.
+*/
+function fcn( v: any, index: number ): number {
+	if ( v !== v ) {
+		throw new Error( 'beep' );
+	}
+	return index;
+}
+
 
 // TESTS //
 
 // The function returns a collection...
 {
-	forEach( [ 0, 1, 1 ], log ); // $ExpectType Collection
-	forEach( [ -1, 1, 2 ], log, {} ); // $ExpectType Collection
+	forEach( [ 0, 1, 1 ], fcn ); // $ExpectType Collection<number>
+	forEach( [ -1, 1, 2 ], fcn, {} ); // $ExpectType Collection<number>
 }
 
 // The compiler throws an error if the function is provided a first argument which is not a collection...
 {
-	forEach( 2, log ); // $ExpectError
-	forEach( false, log ); // $ExpectError
-	forEach( true, log ); // $ExpectError
-	forEach( {}, log ); // $ExpectError
+	forEach( 2, fcn ); // $ExpectError
+	forEach( false, fcn ); // $ExpectError
+	forEach( true, fcn ); // $ExpectError
+	forEach( {}, fcn ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided a second argument which is not a function...
@@ -52,5 +59,5 @@ const log = ( v: any, index: number ): void => {
 {
 	forEach(); // $ExpectError
 	forEach( [ 1, 2, 3 ] ); // $ExpectError
-	forEach( [ 1, 2, 3 ], log, {}, 3 ); // $ExpectError
+	forEach( [ 1, 2, 3 ], fcn, {}, 3 ); // $ExpectError
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-for-each",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "Invoke a function for each element in a collection.",
   "license": "Apache-2.0",
   "author": {
@@ -37,18 +37,18 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-is-collection": "^0.0.8",
-    "@stdlib/assert-is-function": "^0.0.8",
-    "@stdlib/string-format": "^0.0.3",
-    "@stdlib/types": "^0.0.14"
+    "@stdlib/assert-is-collection": "^0.1.0",
+    "@stdlib/assert-is-function": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/types": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-float32": "^0.0.6",
-    "@stdlib/array-float64": "^0.0.6",
-    "@stdlib/assert-is-even": "^0.0.8",
-    "@stdlib/bench": "^0.0.12",
-    "@stdlib/math-base-assert-is-nan": "^0.0.8",
-    "@stdlib/utils-noop": "^0.0.14",
+    "@stdlib/array-float32": "^0.1.0",
+    "@stdlib/array-float64": "^0.1.0",
+    "@stdlib/assert-is-even": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/utils-noop": "^0.1.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
     "tap-min": "git+https://github.com/Planeshifter/tap-min.git"