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>
+
 # inmapRightAsync
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -146,9 +157,9 @@ inmapRightAsync( arr, fcn, done );
 
 The function accepts the following `options`:
 
--   `limit`: the maximum number of pending invocations at any one time. Default: `infinity`.
--   `series`: `boolean` indicating whether to sequentially invoke `fcn` for each `collection` element. If `true`, the function sets `options.limit=1`. Default: `false`.
--   `thisArg`: the execution context for `fcn`.
+-   **limit**: the maximum number of pending invocations at any one time. Default: `infinity`.
+-   **series**: boolean indicating whether to sequentially invoke `fcn` for each `collection` element. If `true`, the function sets `options.limit=1`. Default: `false`.
+-   **thisArg**: the execution context for `fcn`.
 
 By default, all elements are processed concurrently, which means that the function does **not** guarantee completion order. To process each `collection` element sequentially, set the `series` option to `true`.
 
@@ -266,10 +277,10 @@ function done( error, collection ) {
 
 When invoked, `fcn` is provided a maximum of four arguments:
 
--   `value`: collection value.
--   `index`: collection index.
--   `collection`: the input `collection`.
--   `next`: a callback which should be called once `fcn` has finished processing a collection `value`.
+-   **value**: collection value.
+-   **index**: collection index.
+-   **collection**: the input `collection`.
+-   **next**: a callback which should be called once `fcn` has finished processing a collection `value`.
 
 The actual number of provided arguments depends on function `length`. If `fcn` accepts two arguments, `fcn` is provided `value` and `next`. If `fcn` accepts three arguments, `fcn` is provided `value`, `index`, and `next`. For every other `fcn` signature, `fcn` is provided all four arguments.
 
@@ -310,7 +321,7 @@ inmapRightAsync( arr, fcn, done );
 
 #### inmapRightAsync.factory( \[options,] fcn )
 
-Returns a `function` which invokes a function once for each element in a `collection`, iterating from right to left.
+Returns a function which invokes a function once for each element in a `collection`, iterating from right to left.
 
 ```javascript
 function fcn( value, index, next ) {

dist/index.d.ts

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

dist/index.js

@@ -16,91 +16,90 @@
 * 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, U, V> {
 	/**
-	* The maximum number of pending invocations at any one time.
+	* Execution context.
 	*/
-	limit?: number;
+	thisArg?: ThisParameterType<Fcn<T, U, V>>;
 
 	/**
-	* Boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection (default: false).
+	* The maximum number of pending invocations at any one time.
 	*/
-	series?: boolean;
+	limit?: number;
 
 	/**
-	* Execution context.
+	* Boolean indicating whether to sequentially invoke the provided function for each `collection` element. If `true`, the function sets `options.limit=1`. Default: false.
 	*/
-	thisArg?: any;
+	series?: boolean;
 }
 
 /**
 * 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 - error argument
 */
-type DoneUnary = ( error: Error ) => void;
+type Unary = ( error: Error ) => void;
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.
 *
 * @param error - error argument
 * @param collection - updated input collection
 */
-type DoneBinary = ( error: Error, collection: Collection ) => void;
+type Binary<U> = ( error: Error, collection: Collection<U> ) => void;
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.
 *
 * @param error - error argument
 * @param collection - updated input collection
 */
-type DoneCallback = DoneNullary | DoneUnary | DoneBinary;
+type Callback<U> = Nullary | Unary | Binary<U>;
 
 /**
 * Callback function.
 *
 * @param error - error argument
-* @param result - value used to update the collection
 */
-type Unary = ( error: Error ) => void;
+type UnaryNext = ( error: Error ) => void;
 
 /**
 * Callback function.
 *
 * @param error - error argument
 * @param result - value used to update the collection
 */
-type Binary = ( error: Error | null, result: any ) => void;
+type BinaryNext<U> = ( error: Error | null, result: U ) => void;
 
 /**
 * Callback function.
 *
 * @param error - error argument
 * @param result - value used to update the collection
 */
-type Callback = Unary | Binary;
+type Next<U> = UnaryNext | BinaryNext<U>;
 
 /**
 * Function invoked for each element in a collection.
 *
 * @param value - collection value
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type BinaryFcn = ( value: any, next: Callback ) => void;
+type BinaryFcn<T, U, V> = ( this: V, value: T, next: Next<U> ) => void;
 
 /**
 * Function invoked for each element in a collection.
@@ -109,7 +108,7 @@ type BinaryFcn = ( value: any, next: Callback ) => void;
 * @param index - collection index
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type TernaryFcn = ( value: any, index: number, next: Callback ) => void;
+type TernaryFcn<T, U, V> = ( this: V, value: T, index: number, next: Next<U> ) => void;
 
 /**
 * Function invoked for each element in a collection.
@@ -119,7 +118,7 @@ type TernaryFcn = ( value: any, index: number, next: Callback ) => void;
 * @param collection - input collection
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type QuaternaryFcn = ( value: any, index: number, collection: Collection, next: Callback ) => void; // tslint-disable-line max-line-length
+type QuaternaryFcn<T, U, V> = ( this: V, value: T, index: number, collection: Collection<U>, next: Next<U> ) => void;
 
 /**
 * Function invoked for each element in a collection.
@@ -129,15 +128,15 @@ type QuaternaryFcn = ( value: any, index: number, collection: Collection, next:
 * @param collection - input collection
 * @param next - a callback to be invoked after processing a collection `value`
 */
-type Fcn = BinaryFcn | TernaryFcn | QuaternaryFcn;
+type Fcn<T, U, V> = BinaryFcn<T, U, V> | TernaryFcn<T, U, V> | QuaternaryFcn<T, U, V>;
 
 /**
 * Invokes the provided function for each element in a collection and updates a collection in-place.
 *
 * @param collection - input collection
 * @param done - function to invoke upon completion
 */
-type FactoryFunction = ( collection: Collection, done: DoneCallback ) => void;
+type FactoryFunction<T, U> = ( collection: Collection<T>, done: Callback<U> ) => void;
 
 /**
 * Interface for `inmapRightAsync`.
@@ -151,7 +150,6 @@ interface InMapRightAsync {
 	* -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 	* -   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
@@ -192,7 +190,7 @@ interface InMapRightAsync {
 	*
 	* inmapRightAsync( files, {}, read, done );
 	*/
-	( collection: Collection, options: Options, fcn: Fcn, done: DoneCallback ): void; // tslint-disable-line max-line-length
+	<T = unknown, U = unknown, V = unknown>( collection: Collection<T>, options: Options<T, U, V>, fcn: Fcn<T, U, V>, done: Callback<U> ): void;
 
 	/**
 	* Invokes a function once for each element in a collection and updates a collection in-place.
@@ -202,7 +200,6 @@ interface InMapRightAsync {
 	* -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 	* -   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 fcn - function to invoke for each element in a collection
 	* @param done - function to invoke upon completion
@@ -238,7 +235,7 @@ interface InMapRightAsync {
 	*
 	* inmapRightAsync( files, read, done );
 	*/
-	( collection: Collection, fcn: Fcn, done: DoneCallback ): void;
+	<T = unknown, U = unknown, V = unknown>( collection: Collection<T>, fcn: Fcn<T, U, V>, done: Callback<U> ): void; // tslint:disable-line:no-unnecessary-generics
 
 	/**
 	* Returns a function to invoke a function once for each element in a collection and to update the collection in-place.
@@ -248,7 +245,6 @@ interface InMapRightAsync {
 	* -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 	* -   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
@@ -298,7 +294,7 @@ interface InMapRightAsync {
 	* // Run `read` for each element in `files`:
 	* inmapRightAsync( files, done );
 	*/
-	factory( options: Options, fcn: Fcn ): FactoryFunction;
+	factory<T = unknown, U = unknown, V = unknown>( options: Options<T, U, V>, fcn: Fcn<T, U, V> ): FactoryFunction<T, U>;
 
 	/**
 	* Returns a function to invoke a function once for each element in a collection and to update the collection in-place.
@@ -308,7 +304,6 @@ interface InMapRightAsync {
 	* -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 	* -   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 fcn - function to invoke for each element in a collection
 	* @throws must provide valid options
 	* @returns function which invokes the provided function once for each element in a collection
@@ -350,7 +345,7 @@ interface InMapRightAsync {
 	* // Run `read` for each element in `files`:
 	* inmapRightAsync( files, done );
 	*/
-	factory( fcn: Fcn ): FactoryFunction;
+	factory<T = unknown, U = unknown, V = unknown>( fcn: Fcn<T, U, V> ): FactoryFunction<T, U>; // tslint:disable-line:no-unnecessary-generics
 }
 
 /**
@@ -361,7 +356,6 @@ interface InMapRightAsync {
 * -   If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
 * -   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

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