@stdlib/utils-async 0.1.0 → 0.2.0

package/NOTICE

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

package/README.md

@@ -160,7 +160,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
+Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -173,8 +173,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/utils-async.svg
 [npm-url]: https://npmjs.org/package/@stdlib/utils-async
 
-[test-image]: https://github.com/stdlib-js/utils-async/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/utils-async/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/utils-async/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/utils-async/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-async/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/utils-async?branch=main
@@ -197,8 +197,11 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/utils-async/tree/deno
+[deno-readme]: https://github.com/stdlib-js/utils-async/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/utils-async/tree/umd
+[umd-readme]: https://github.com/stdlib-js/utils-async/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/utils-async/tree/esm
+[esm-readme]: https://github.com/stdlib-js/utils-async/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/utils-async/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async/main/LICENSE

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/docs/types/index.d.ts

@@ -18,8 +18,7 @@
 
 // TypeScript Version: 4.1
 
-/* tslint:disable:max-line-length */
-/* tslint:disable:max-file-line-count */
+/* eslint-disable max-lines */
 
 import anyByAsync = require( '@stdlib/utils-async-any-by' );
 import anyByRightAsync = require( '@stdlib/utils-async-any-by-right' );
@@ -76,7 +75,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -130,7 +129,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -184,7 +183,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, result ) {
 	*     if ( error ) {
@@ -281,7 +280,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, result ) {
 	*     if ( error ) {
@@ -393,7 +392,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -447,7 +446,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -501,7 +500,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error ) {
 	*     if ( error ) {
@@ -552,7 +551,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error ) {
 	*     if ( error ) {
@@ -647,7 +646,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, result ) {
 	*     if ( error ) {
@@ -688,7 +687,7 @@ interface Namespace {
 	* @param done - callback to invoke upon completion
 	*
 	* @example
-	* var randu = require( `@stdlib/random/base/randu` );
+	* var randu = require( '@stdlib/random-base-randu' );
 	*
 	* function predicate( clbk ) {
 	*     setTimeout( onTimeout, 0 );
@@ -716,7 +715,7 @@ interface Namespace {
 	* @param done - callback to invoke upon completion
 	*
 	* @example
-	* var randu = require( `@stdlib/random/base/randu` );
+	* var randu = require( '@stdlib/random-base-randu' );
 	*
 	* function predicate( clbk ) {
 	*     setTimeout( onTimeout, 0 );
@@ -767,7 +766,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, results ) {
 	*     if ( error ) {
@@ -817,7 +816,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, results ) {
 	*     if ( error ) {
@@ -909,7 +908,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function read( key, value, next ) {
 	*     var opts = {
@@ -969,7 +968,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var stat = require( `fs` ).stat;
+	* var stat = require( 'fs' ).stat;
 	*
 	* function getStats( file, next ) {
 	*     stat( file, onStats );
@@ -1023,7 +1022,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -1077,7 +1076,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -1132,7 +1131,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, acc ) {
 	*     if ( error ) {
@@ -1186,7 +1185,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, acc ) {
 	*     if ( error ) {
@@ -1272,7 +1271,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -1328,7 +1327,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, bool ) {
 	*     if ( error ) {
@@ -1387,7 +1386,7 @@ interface Namespace {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, result ) {
 	*     if ( error ) {
@@ -1427,7 +1426,7 @@ interface Namespace {
 	* @param done - callback to invoke upon completion
 	*
 	* @example
-	* var randu = require( `@stdlib/random/base/randu` );
+	* var randu = require( '@stdlib/random-base-randu' );
 	*
 	* function x( clbk ) {
 	*     setTimeout( onTimeout, 0 );
@@ -1458,7 +1457,7 @@ interface Namespace {
 	* @param done - callback to invoke upon completion
 	*
 	* @example
-	* var randu = require( `@stdlib/random/base/randu` );
+	* var randu = require( '@stdlib/random-base-randu' );
 	*
 	* function x( clbk ) {
 	*     setTimeout( onTimeout, 0 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-async",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Standard async utilities.",
   "license": "Apache-2.0",
   "author": {
@@ -36,68 +36,69 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/utils-async-any-by": "^0.1.0",
-    "@stdlib/utils-async-any-by-right": "^0.1.0",
-    "@stdlib/utils-async-bifurcate-by": "^0.1.0",
-    "@stdlib/utils-async-compose": "^0.1.0",
-    "@stdlib/utils-async-count-by": "^0.1.0",
-    "@stdlib/utils-async-do-until": "^0.1.0",
-    "@stdlib/utils-async-do-while": "^0.1.0",
-    "@stdlib/utils-async-every-by": "^0.1.0",
-    "@stdlib/utils-async-every-by-right": "^0.1.0",
-    "@stdlib/utils-async-for-each": "^0.1.0",
-    "@stdlib/utils-async-for-each-right": "^0.1.0",
-    "@stdlib/utils-async-function-sequence": "^0.1.0",
-    "@stdlib/utils-async-group-by": "^0.1.0",
-    "@stdlib/utils-async-if-else": "^0.1.0",
-    "@stdlib/utils-async-if-then": "^0.1.0",
-    "@stdlib/utils-async-inmap": "^0.1.0",
-    "@stdlib/utils-async-inmap-right": "^0.1.0",
-    "@stdlib/utils-async-map-function": "^0.1.0",
-    "@stdlib/utils-async-map-keys": "^0.0.8",
-    "@stdlib/utils-async-map-values": "^0.0.8",
-    "@stdlib/utils-async-none-by": "^0.1.0",
-    "@stdlib/utils-async-none-by-right": "^0.1.0",
-    "@stdlib/utils-async-reduce": "^0.1.0",
-    "@stdlib/utils-async-reduce-right": "^0.1.0",
-    "@stdlib/utils-async-series-waterfall": "^0.1.0",
-    "@stdlib/utils-async-some-by": "^0.1.0",
-    "@stdlib/utils-async-some-by-right": "^0.1.0",
-    "@stdlib/utils-async-tabulate-by": "^0.1.0",
-    "@stdlib/utils-async-try-catch": "^0.1.0",
-    "@stdlib/utils-async-try-then": "^0.1.0",
-    "@stdlib/utils-async-until": "^0.1.0",
-    "@stdlib/utils-async-while": "^0.1.0",
-    "@stdlib/utils-define-read-only-property": "^0.1.0"
+    "@stdlib/utils-async-any-by": "^0.2.0",
+    "@stdlib/utils-async-any-by-right": "^0.2.0",
+    "@stdlib/utils-async-bifurcate-by": "^0.2.0",
+    "@stdlib/utils-async-compose": "^0.2.0",
+    "@stdlib/utils-async-count-by": "^0.2.0",
+    "@stdlib/utils-async-do-until": "^0.2.0",
+    "@stdlib/utils-async-do-while": "^0.2.0",
+    "@stdlib/utils-async-every-by": "^0.2.0",
+    "@stdlib/utils-async-every-by-right": "^0.2.0",
+    "@stdlib/utils-async-for-each": "^0.2.0",
+    "@stdlib/utils-async-for-each-right": "^0.2.0",
+    "@stdlib/utils-async-function-sequence": "^0.2.0",
+    "@stdlib/utils-async-group-by": "^0.2.0",
+    "@stdlib/utils-async-if-else": "^0.2.0",
+    "@stdlib/utils-async-if-then": "^0.2.0",
+    "@stdlib/utils-async-inmap": "^0.2.0",
+    "@stdlib/utils-async-inmap-right": "^0.2.0",
+    "@stdlib/utils-async-map-function": "^0.2.0",
+    "@stdlib/utils-async-map-keys": "^0.2.0",
+    "@stdlib/utils-async-map-values": "^0.2.0",
+    "@stdlib/utils-async-none-by": "^0.2.0",
+    "@stdlib/utils-async-none-by-right": "^0.2.0",
+    "@stdlib/utils-async-reduce": "^0.2.0",
+    "@stdlib/utils-async-reduce-right": "^0.2.0",
+    "@stdlib/utils-async-series-waterfall": "^0.2.0",
+    "@stdlib/utils-async-some-by": "^0.2.0",
+    "@stdlib/utils-async-some-by-right": "^0.2.0",
+    "@stdlib/utils-async-tabulate-by": "^0.2.0",
+    "@stdlib/utils-async-try-catch": "^0.2.0",
+    "@stdlib/utils-async-try-then": "^0.2.0",
+    "@stdlib/utils-async-until": "^0.2.0",
+    "@stdlib/utils-async-while": "^0.2.0",
+    "@stdlib/utils-define-read-only-property": "^0.2.0"
   },
   "devDependencies": {
-    "@stdlib/assert-has-own-property": "^0.1.0",
-    "@stdlib/assert-is-array": "^0.1.0",
-    "@stdlib/assert-is-boolean": "^0.1.0",
+    "@stdlib/assert-has-own-property": "^0.1.1",
+    "@stdlib/assert-is-array": "^0.1.1",
+    "@stdlib/assert-is-boolean": "^0.1.1",
     "@stdlib/assert-is-collection": "^0.1.0",
-    "@stdlib/assert-is-function": "^0.1.0",
-    "@stdlib/assert-is-function-array": "^0.1.0",
-    "@stdlib/assert-is-nan": "^0.1.0",
+    "@stdlib/assert-is-function": "^0.1.1",
+    "@stdlib/assert-is-function-array": "^0.2.0",
+    "@stdlib/assert-is-nan": "^0.1.1",
     "@stdlib/assert-is-nonnegative-integer": "^0.1.0",
-    "@stdlib/assert-is-plain-object": "^0.1.0",
+    "@stdlib/assert-is-plain-object": "^0.1.1",
     "@stdlib/assert-is-positive-integer": "^0.1.0",
-    "@stdlib/bench": "^0.1.0",
-    "@stdlib/constants-float64-eps": "^0.1.0",
-    "@stdlib/constants-float64-pinf": "^0.1.0",
-    "@stdlib/fs-read-file": "^0.1.0",
-    "@stdlib/math-base-assert-is-nan": "^0.1.0",
-    "@stdlib/math-base-special-ceil": "^0.0.8",
-    "@stdlib/random-base-randu": "^0.0.8",
-    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/constants-float64-eps": "^0.1.1",
+    "@stdlib/constants-float64-pinf": "^0.1.1",
+    "@stdlib/fs-read-file": "^0.1.1",
+    "@stdlib/math-base-assert-is-nan": "^0.1.1",
+    "@stdlib/math-base-special-ceil": "^0.1.1",
+    "@stdlib/random-base-randu": "^0.1.0",
+    "@stdlib/string-format": "^0.2.0",
     "@stdlib/string-repeat": "^0.1.0",
-    "@stdlib/string-replace": "^0.1.0",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
+    "@stdlib/string-replace": "^0.1.1",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0",
     "@stdlib/utils-index-of": "^0.1.0",
     "@stdlib/utils-keys": "^0.1.0",
-    "@stdlib/utils-noop": "^0.1.0",
+    "@stdlib/utils-noop": "^0.2.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"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
+    "@stdlib/bench-harness": "^0.2.0",
+    "@stdlib/bench": "^0.3.1"
   },
   "engines": {
     "node": ">=0.10.0",

package/CITATION.cff

@@ -1,30 +0,0 @@
-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