@stdlib/utils-parallel 0.2.0 → 0.3.0

package/NOTICE

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

package/README.md

@@ -57,9 +57,11 @@ var parallel = require( '@stdlib/utils-parallel' );
 
 Executes scripts in parallel.
 
+<!-- FIXME: revert back to JavaScript once can handle errors -->
+
 <!-- run-disable -->
 
-```javascript
+```text
 var files = [
     './a.js',
     './b.js'
@@ -89,9 +91,11 @@ The function accepts the following `options`:
 
 By default, the number of workers running scripts is equal to the number of CPUs minus `1` (master process). To adjust the number of workers, set the `workers` option.
 
+<!-- FIXME: revert back to JavaScript once can handle errors -->
+
 <!-- run-disable -->
 
-```javascript
+```text
 var files = [
     './a.js',
     './b.js'
@@ -115,9 +119,11 @@ parallel( files, opts, done );
 
 By default, the number of scripts running concurrently is equal to the number of workers. To adjust the concurrency, set the `concurrency` option.
 
+<!-- FIXME: revert back to JavaScript once can handle errors -->
+
 <!-- run-disable -->
 
-```javascript
+```text
 var files = [
     './a.js',
     './b.js'
@@ -149,9 +155,11 @@ $ node <script_path>
 
 To run scripts via an alternative executable or none at all, set the `cmd` option.
 
+<!-- FIXME: revert back to JavaScript once can handle errors -->
+
 <!-- run-disable -->
 
-```javascript
+```text
 var files = [
     './a.js',
     './b.js'
@@ -175,9 +183,11 @@ parallel( files, opts, done );
 
 By default, the `stdio` output for each script is interleaved; i.e., the `stdio` output from one script **may** be interleaved with the `stdio` output from one or more other scripts. To preserve the `stdio` output order for each script, set the `ordered` option to `true`.
 
+<!-- FIXME: revert back to JavaScript once can handle errors -->
+
 <!-- run-disable -->
 
-```javascript
+```text
 var files = [
     './a.js',
     './b.js'
@@ -220,9 +230,11 @@ parallel( files, opts, done );
 
 ## Examples
 
+<!-- FIXME: re-enable running of code block once able to set `maxBuffer` configuration -->
+
 <!-- run-disable -->
 
-<!-- FIXME: re-enable running of code block once able to set `maxBuffer` configuration -->
+<!-- eslint-disable node/no-sync -->
 
 <!-- eslint no-undef: "error" -->
 
@@ -363,7 +375,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -378,8 +390,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/utils-parallel.svg
 [npm-url]: https://npmjs.org/package/@stdlib/utils-parallel
 
-[test-image]: https://github.com/stdlib-js/utils-parallel/actions/workflows/test.yml/badge.svg?branch=v0.2.0
-[test-url]: https://github.com/stdlib-js/utils-parallel/actions/workflows/test.yml?query=branch:v0.2.0
+[test-image]: https://github.com/stdlib-js/utils-parallel/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/utils-parallel/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-parallel/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/utils-parallel?branch=main
@@ -406,8 +418,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-parallel/tree/deno
+[deno-readme]: https://github.com/stdlib-js/utils-parallel/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/utils-parallel/tree/umd
+[umd-readme]: https://github.com/stdlib-js/utils-parallel/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/utils-parallel/tree/esm
+[esm-readme]: https://github.com/stdlib-js/utils-parallel/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/utils-parallel/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-parallel/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

@@ -133,7 +133,7 @@ declare function parallel( files: Array<string>, clbk: Callback ): void;
 *
 * parallel( files, opts, done );
 */
-declare function parallel( files: Array<string>, options: Options, clbk: Callback ): void; // tslint-disable-line max-line-length
+declare function parallel( files: Array<string>, options: Options, clbk: Callback ): void;
 
 
 // EXPORTS //

package/lib/node/worker/worker.js

@@ -56,7 +56,7 @@ function onMessage( message ) {
 		debug( 'Environment configuration allows interleaved script output.' );
 		child = spawn( proc.env.WORKER_CMD, message, done );
 	}
-	db[ child.pid ] = true;
+	db[ child.pid ] = child;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-parallel",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Execute scripts in parallel.",
   "license": "Apache-2.0",
   "author": {
@@ -39,17 +39,20 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.1.0",
-    "@stdlib/assert-is-boolean": "^0.1.0",
-    "@stdlib/assert-is-function": "^0.1.0",
-    "@stdlib/assert-is-nonnegative-integer": "^0.1.0",
-    "@stdlib/assert-is-plain-object": "^0.1.0",
-    "@stdlib/assert-is-positive-integer": "^0.1.0",
-    "@stdlib/assert-is-string": "^0.1.0",
-    "@stdlib/assert-is-string-array": "^0.1.0",
-    "@stdlib/os-num-cpus": "^0.1.0",
-    "@stdlib/process-cwd": "^0.1.0",
-    "@stdlib/string-format": "^0.1.0"
+    "@stdlib/assert-has-own-property": "^0.1.1",
+    "@stdlib/assert-is-boolean": "^0.2.0",
+    "@stdlib/assert-is-function": "^0.2.0",
+    "@stdlib/assert-is-nonnegative-integer": "^0.2.0",
+    "@stdlib/assert-is-plain-object": "^0.2.0",
+    "@stdlib/assert-is-positive-integer": "^0.2.0",
+    "@stdlib/assert-is-string": "^0.2.0",
+    "@stdlib/assert-is-string-array": "^0.2.0",
+    "@stdlib/os-num-cpus": "^0.2.0",
+    "@stdlib/process-cwd": "^0.2.0",
+    "@stdlib/process-env": "^0.2.0",
+    "@stdlib/string-format": "^0.2.0",
+    "@stdlib/utils-keys": "^0.2.0",
+    "debug": "^2.6.9"
   },
   "devDependencies": {
     "proxyquire": "^2.0.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