@stdlib/utils-async-parallel 0.1.0 → 0.1.1

package/NOTICE

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

package/README.md

@@ -306,7 +306,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -319,8 +319,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/utils-async-parallel.svg
 [npm-url]: https://npmjs.org/package/@stdlib/utils-async-parallel
 
-[test-image]: https://github.com/stdlib-js/utils-async-parallel/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/utils-async-parallel/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/utils-async-parallel/actions/workflows/test.yml/badge.svg?branch=v0.1.1
+[test-url]: https://github.com/stdlib-js/utils-async-parallel/actions/workflows/test.yml?query=branch:v0.1.1
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-async-parallel/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/utils-async-parallel?branch=main
@@ -332,8 +332,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../lib/validate.js", "../lib/limit.js", "../lib/factory.js", "../lib/main.js", "../lib/index.js"],
-  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive;\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {*} [options.thisArg] - execution context\n* @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n*     'thisArg': {},\n*     'limit': 10\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n*     throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'thisArg' ) ) {\n\t\topts.thisArg = options.thisArg;\n\t}\n\tif ( hasOwnProp( options, 'limit' ) ) {\n\t\topts.limit = options.limit;\n\t\tif ( !isPositiveInteger( opts.limit ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a positive integer. Option: `%s`.', 'limit', opts.limit ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar logger = require( 'debug' );\n\n\n// VARIABLES //\n\nvar debug = logger( 'parallel-async:limit' );\n\n\n// MAIN //\n\n/**\n* Invokes functions in a provided array, limiting the number of concurrently pending functions.\n*\n* @private\n* @param {FunctionArray} fcns - array of functions\n* @param {Options} opts - function options\n* @param {*} [opts.thisArg] - execution context\n* @param {PositiveInteger} [opts.limit] - maximum number of pending function invocations\n* @param {Callback} done - function to invoke upon completion or upon encountering an error\n* @returns {void}\n*/\nfunction limit( fcns, opts, done ) {\n\tvar maxIndex;\n\tvar count;\n\tvar flg;\n\tvar lim;\n\tvar len;\n\tvar idx;\n\tvar out;\n\tvar i;\n\n\tlen = fcns.length;\n\tdebug( 'Number of functions: %d', len );\n\n\tout = new Array( len );\n\tif ( len < opts.limit ) {\n\t\tlim = len;\n\t} else {\n\t\tlim = opts.limit;\n\t}\n\tdebug( 'Concurrency limit: %d', lim );\n\n\tmaxIndex = len - 1;\n\tcount = 0;\n\tidx = -1;\n\tfor ( i = 0; i < lim; i++ ) {\n\t\t// This guard is necessary to protect against synchronous functions...\n\t\tif ( idx < maxIndex ) {\n\t\t\tnext(); // eslint-disable-line node/callback-return\n\t\t}\n\t}\n\t/**\n\t* Callback to invoke the next function.\n\t*\n\t* @private\n\t*/\n\tfunction next() {\n\t\tvar i;\n\n\t\tidx += 1;\n\n\t\t// Cache the current index value to allow storing results later:\n\t\ti = idx;\n\n\t\tfcns[ idx ].call( opts.thisArg, resolve );\n\n\t\t/**\n\t\t* Callback invoked once a provided function finishes.\n\t\t*\n\t\t* @private\n\t\t* @param {*} [error] - error\n\t\t* @param {*} [results] - results\n\t\t* @returns {void}\n\t\t*/\n\t\tfunction resolve( error, results ) {\n\t\t\tif ( flg ) {\n\t\t\t\t// Prevent further processing:\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tif ( error ) {\n\t\t\t\tflg = true;\n\t\t\t\treturn clbk( error );\n\t\t\t}\n\t\t\tout[ i ] = results;\n\t\t\tclbk();\n\t\t}\n\t}\n\n\t/**\n\t* Callback invoked once ready to process the next function.\n\t*\n\t* @private\n\t* @param {*} [error] - error\n\t* @returns {void}\n\t*/\n\tfunction clbk( error ) {\n\t\tif ( error ) {\n\t\t\tdebug( 'Encountered an error: %s', error.message );\n\t\t\treturn done( error );\n\t\t}\n\t\tcount += 1;\n\t\tdebug( 'Processed %d of %d functions.', count, len );\n\t\tif ( idx < maxIndex ) {\n\t\t\treturn next();\n\t\t}\n\t\tif ( count === len ) {\n\t\t\tdebug( 'Finished processing the functions.' );\n\t\t\treturn done( null, out );\n\t\t}\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = limit;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isFunctionArray = require( '@stdlib/assert-is-function-array' );\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar format = require( '@stdlib/string-format' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\nvar validate = require( './validate.js' );\nvar limit = require( './limit.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function to execute a set of functions in parallel.\n*\n* @param {FunctionArray} fcns - array of functions\n* @param {Options} [options] - function options\n* @param {*} [options.thisArg] - execution context\n* @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time\n* @throws {TypeError} first argument must be an array of functions\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Function} parallel function\n*\n* @example\n* function a( resolve ) {\n*     setTimeout( onTimeout, 0 );\n*     function onTimeout() {\n*         resolve( null, 2 );\n*     }\n* }\n*\n* function b( resolve ) {\n*     setTimeout( onTimeout, 0 );\n*     function onTimeout() {\n*         resolve( null, 4 );\n*     }\n* }\n*\n* function done( error, out ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( out );\n*     // => [ 2, 4 ]\n* }\n*\n* var fcns = [ a, b ];\n*\n* var run = parallel.factory( fcns );\n*\n* run( done );\n*/\nfunction factory( fcns, options ) {\n\tvar opts;\n\tvar err;\n\n\tif ( !isFunctionArray( fcns ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array of functions. Value: `%s`.', fcns ) );\n\t}\n\topts = {\n\t\t'limit': PINF\n\t};\n\tif ( arguments.length > 1 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\treturn parallel;\n\n\t/**\n\t* Executes a set of functions in parallel and returns an array of results.\n\t*\n\t* @private\n\t* @param {Callback} done - function to invoke upon completion\n\t* @throws {TypeError} must provide a function\n\t* @returns {void}\n\t*/\n\tfunction parallel( done ) {\n\t\tif ( !isFunction( done ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', done ) );\n\t\t}\n\t\treturn limit( fcns, opts, clbk );\n\n\t\t/**\n\t\t* Callback invoked upon completion.\n\t\t*\n\t\t* @private\n\t\t* @param {*} [error] - error\n\t\t* @param {Array} [out] - output array\n\t\t* @returns {void}\n\t\t*/\n\t\tfunction clbk( error, out ) {\n\t\t\tif ( error ) {\n\t\t\t\treturn done( error );\n\t\t\t}\n\t\t\tdone( null, out );\n\t\t}\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Executes a set of functions in parallel.\n*\n* @param {FunctionArray} fcns - array of functions\n* @param {Options} [options] - function options\n* @param {*} [options.thisArg] - execution context\n* @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time\n* @param {Callback} done - function to invoke upon completion\n* @throws {TypeError} first argument must be an array of functions\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {TypeError} callback argument must be a function\n* @returns {void}\n*\n* @example\n* var parallel = require( '@stdlib/utils-async-parallel' );\n*\n* function foo( resolve ) {\n*     setTimeout( onTimeout, 300 );\n*     function onTimeout() {\n*         resolve( null, 'one' );\n*     }\n* }\n*\n* function bar( resolve ) {\n*     setTimeout( onTimeout, 100 );\n*     function onTimeout() {\n*         resolve( null, 'two' );\n*     }\n* }\n*\n* function done( error, results ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( results );\n*     // => [ 'one', 'two' ]\n* }\n*\n* var fcns = [ foo, bar ];\n*\n* parallel( fcns, done );\n*/\nfunction parallel( fcns, options, done ) {\n\tif ( arguments.length < 3 ) {\n\t\treturn factory( fcns )( options );\n\t}\n\tfactory( fcns, options )( done );\n}\n\n\n// EXPORTS //\n\nmodule.exports = parallel;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Execute a set of functions in parallel.\n*\n* @module @stdlib/utils-async-parallel\n*\n* @example\n* var parallel = require( '@stdlib/utils-async-parallel' );\n*\n* function foo( resolve ) {\n*     setTimeout( onTimeout, 300 );\n*     function onTimeout() {\n*         resolve( null, 'one' );\n*     }\n* }\n*\n* function bar( resolve ) {\n*     setTimeout( onTimeout, 100 );\n*     function onTimeout() {\n*         resolve( null, 'two' );\n*     }\n* }\n*\n* function done( error, results ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( results );\n*     // => [ 'one', 'two' ]\n* }\n*\n* var fcns = [ foo, bar ];\n*\n* parallel( fcns, done );\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
-  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAoB,QAAS,oCAAqC,EAAE,YACpEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMN,EAAUM,CAAQ,GAGnBL,EAAYK,EAAS,SAAU,IACnCD,EAAK,QAAUC,EAAQ,SAEnBL,EAAYK,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACJ,EAAmBG,EAAK,KAAM,GAC5B,IAAI,UAAWF,EAAQ,wEAAyE,QAASE,EAAK,KAAM,CAAE,EAGxH,MAXC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAYhH,CAKAP,EAAO,QAAUK,ICtEjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,OAAQ,EAK1BC,EAAQD,EAAQ,sBAAuB,EAgB3C,SAASE,EAAOC,EAAMC,EAAMC,EAAO,CAClC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAgBJ,IAdAH,EAAMP,EAAK,OACXF,EAAO,0BAA2BS,CAAI,EAEtCE,EAAM,IAAI,MAAOF,CAAI,EAChBA,EAAMN,EAAK,MACfK,EAAMC,EAEND,EAAML,EAAK,MAEZH,EAAO,wBAAyBQ,CAAI,EAEpCH,EAAWI,EAAM,EACjBH,EAAQ,EACRI,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKI,IAEhBF,EAAML,GACVQ,EAAK,EAQP,SAASA,GAAO,CACf,IAAID,EAEJF,GAAO,EAGPE,EAAIF,EAEJR,EAAMQ,CAAI,EAAE,KAAMP,EAAK,QAASW,CAAQ,EAUxC,SAASA,EAASC,EAAOC,EAAU,CAClC,GAAK,CAAAT,EAIL,IAAKQ,EACJ,OAAAR,EAAM,GACCU,EAAMF,CAAM,EAEpBJ,EAAKC,CAAE,EAAII,EACXC,EAAK,EACN,CACD,CASA,SAASA,EAAMF,EAAQ,CACtB,GAAKA,EACJ,OAAAf,EAAO,2BAA4Be,EAAM,OAAQ,EAC1CX,EAAMW,CAAM,EAIpB,GAFAT,GAAS,EACTN,EAAO,gCAAiCM,EAAOG,CAAI,EAC9CC,EAAML,EACV,OAAOQ,EAAK,EAEb,GAAKP,IAAUG,EACd,OAAAT,EAAO,oCAAqC,EACrCI,EAAM,KAAMO,CAAI,CAEzB,CACD,CAKAb,EAAO,QAAUG,ICzIjB,IAAAiB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAkB,QAAS,kCAAmC,EAC9DC,EAAa,QAAS,4BAA6B,EACnDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAO,QAAS,gCAAiC,EACjDC,EAAW,IACXC,EAAQ,IA8CZ,SAASC,EAASC,EAAMC,EAAU,CACjC,IAAIC,EACAC,EAEJ,GAAK,CAACV,EAAiBO,CAAK,EAC3B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAK,CAAE,EAKrH,GAHAE,EAAO,CACN,MAASN,CACV,EACK,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,OAAOC,EAUP,SAASA,EAAUC,EAAO,CACzB,GAAK,CAACX,EAAYW,CAAK,EACtB,MAAM,IAAI,UAAWV,EAAQ,uEAAwEU,CAAK,CAAE,EAE7G,OAAOP,EAAOE,EAAME,EAAMI,CAAK,EAU/B,SAASA,EAAMC,EAAOC,EAAM,CAC3B,GAAKD,EACJ,OAAOF,EAAME,CAAM,EAEpBF,EAAM,KAAMG,CAAI,CACjB,CACD,CACD,CAKAhB,EAAO,QAAUO,IC7HjB,IAAAU,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IAgDd,SAASC,EAAUC,EAAMC,EAASC,EAAO,CACxC,GAAK,UAAU,OAAS,EACvB,OAAOJ,EAASE,CAAK,EAAGC,CAAQ,EAEjCH,EAASE,EAAMC,CAAQ,EAAGC,CAAK,CAChC,CAKAL,EAAO,QAAUE,ICvBjB,IAAII,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive;\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {*} [options.thisArg] - execution context\n* @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n*     'thisArg': {},\n*     'limit': 10\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n*     throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'thisArg' ) ) {\n\t\topts.thisArg = options.thisArg;\n\t}\n\tif ( hasOwnProp( options, 'limit' ) ) {\n\t\topts.limit = options.limit;\n\t\tif ( !isPositiveInteger( opts.limit ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a positive integer. Option: `%s`.', 'limit', opts.limit ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar logger = require( 'debug' );\n\n\n// VARIABLES //\n\nvar debug = logger( 'parallel-async:limit' );\n\n\n// MAIN //\n\n/**\n* Invokes functions in a provided array, limiting the number of concurrently pending functions.\n*\n* @private\n* @param {FunctionArray} fcns - array of functions\n* @param {Options} opts - function options\n* @param {*} [opts.thisArg] - execution context\n* @param {PositiveInteger} [opts.limit] - maximum number of pending function invocations\n* @param {Callback} done - function to invoke upon completion or upon encountering an error\n* @returns {void}\n*/\nfunction limit( fcns, opts, done ) {\n\tvar maxIndex;\n\tvar count;\n\tvar flg;\n\tvar lim;\n\tvar len;\n\tvar idx;\n\tvar out;\n\tvar i;\n\n\tlen = fcns.length;\n\tdebug( 'Number of functions: %d', len );\n\n\tout = new Array( len ); // eslint-disable-line stdlib/no-new-array\n\tif ( len < opts.limit ) {\n\t\tlim = len;\n\t} else {\n\t\tlim = opts.limit;\n\t}\n\tdebug( 'Concurrency limit: %d', lim );\n\n\tmaxIndex = len - 1;\n\tcount = 0;\n\tidx = -1;\n\tfor ( i = 0; i < lim; i++ ) {\n\t\t// This guard is necessary to protect against synchronous functions...\n\t\tif ( idx < maxIndex ) {\n\t\t\tnext(); // eslint-disable-line node/callback-return\n\t\t}\n\t}\n\t/**\n\t* Callback to invoke the next function.\n\t*\n\t* @private\n\t*/\n\tfunction next() {\n\t\tvar i;\n\n\t\tidx += 1;\n\n\t\t// Cache the current index value to allow storing results later:\n\t\ti = idx;\n\n\t\tfcns[ idx ].call( opts.thisArg, resolve );\n\n\t\t/**\n\t\t* Callback invoked once a provided function finishes.\n\t\t*\n\t\t* @private\n\t\t* @param {*} [error] - error\n\t\t* @param {*} [results] - results\n\t\t* @returns {void}\n\t\t*/\n\t\tfunction resolve( error, results ) {\n\t\t\tif ( flg ) {\n\t\t\t\t// Prevent further processing:\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tif ( error ) {\n\t\t\t\tflg = true;\n\t\t\t\treturn clbk( error );\n\t\t\t}\n\t\t\tout[ i ] = results;\n\t\t\tclbk();\n\t\t}\n\t}\n\n\t/**\n\t* Callback invoked once ready to process the next function.\n\t*\n\t* @private\n\t* @param {*} [error] - error\n\t* @returns {void}\n\t*/\n\tfunction clbk( error ) {\n\t\tif ( error ) {\n\t\t\tdebug( 'Encountered an error: %s', error.message );\n\t\t\treturn done( error );\n\t\t}\n\t\tcount += 1;\n\t\tdebug( 'Processed %d of %d functions.', count, len );\n\t\tif ( idx < maxIndex ) {\n\t\t\treturn next();\n\t\t}\n\t\tif ( count === len ) {\n\t\t\tdebug( 'Finished processing the functions.' );\n\t\t\treturn done( null, out );\n\t\t}\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = limit;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isFunctionArray = require( '@stdlib/assert-is-function-array' );\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar format = require( '@stdlib/string-format' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\nvar validate = require( './validate.js' );\nvar limit = require( './limit.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function to execute a set of functions in parallel.\n*\n* @param {FunctionArray} fcns - array of functions\n* @param {Options} [options] - function options\n* @param {*} [options.thisArg] - execution context\n* @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time\n* @throws {TypeError} first argument must be an array of functions\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Function} parallel function\n*\n* @example\n* function a( resolve ) {\n*     setTimeout( onTimeout, 0 );\n*     function onTimeout() {\n*         resolve( null, 2 );\n*     }\n* }\n*\n* function b( resolve ) {\n*     setTimeout( onTimeout, 0 );\n*     function onTimeout() {\n*         resolve( null, 4 );\n*     }\n* }\n*\n* function done( error, out ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( out );\n*     // => [ 2, 4 ]\n* }\n*\n* var fcns = [ a, b ];\n*\n* var run = parallel.factory( fcns );\n*\n* run( done );\n*/\nfunction factory( fcns, options ) {\n\tvar opts;\n\tvar err;\n\n\tif ( !isFunctionArray( fcns ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array of functions. Value: `%s`.', fcns ) );\n\t}\n\topts = {\n\t\t'limit': PINF\n\t};\n\tif ( arguments.length > 1 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\treturn parallel;\n\n\t/**\n\t* Executes a set of functions in parallel and returns an array of results.\n\t*\n\t* @private\n\t* @param {Callback} done - function to invoke upon completion\n\t* @throws {TypeError} must provide a function\n\t* @returns {void}\n\t*/\n\tfunction parallel( done ) {\n\t\tif ( !isFunction( done ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', done ) );\n\t\t}\n\t\treturn limit( fcns, opts, clbk );\n\n\t\t/**\n\t\t* Callback invoked upon completion.\n\t\t*\n\t\t* @private\n\t\t* @param {*} [error] - error\n\t\t* @param {Array} [out] - output array\n\t\t* @returns {void}\n\t\t*/\n\t\tfunction clbk( error, out ) {\n\t\t\tif ( error ) {\n\t\t\t\treturn done( error );\n\t\t\t}\n\t\t\tdone( null, out );\n\t\t}\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Executes a set of functions in parallel.\n*\n* @param {FunctionArray} fcns - array of functions\n* @param {Options} [options] - function options\n* @param {*} [options.thisArg] - execution context\n* @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time\n* @param {Callback} done - function to invoke upon completion\n* @throws {TypeError} first argument must be an array of functions\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {TypeError} callback argument must be a function\n* @returns {void}\n*\n* @example\n* function foo( resolve ) {\n*     setTimeout( onTimeout, 300 );\n*     function onTimeout() {\n*         resolve( null, 'one' );\n*     }\n* }\n*\n* function bar( resolve ) {\n*     setTimeout( onTimeout, 100 );\n*     function onTimeout() {\n*         resolve( null, 'two' );\n*     }\n* }\n*\n* function done( error, results ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( results );\n*     // => [ 'one', 'two' ]\n* }\n*\n* var fcns = [ foo, bar ];\n*\n* parallel( fcns, done );\n*/\nfunction parallel( fcns, options, done ) {\n\tif ( arguments.length < 3 ) {\n\t\treturn factory( fcns )( options );\n\t}\n\tfactory( fcns, options )( done );\n}\n\n\n// EXPORTS //\n\nmodule.exports = parallel;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Execute a set of functions in parallel.\n*\n* @module @stdlib/utils-async-parallel\n*\n* @example\n* var parallel = require( '@stdlib/utils-async-parallel' );\n*\n* function foo( resolve ) {\n*     setTimeout( onTimeout, 300 );\n*     function onTimeout() {\n*         resolve( null, 'one' );\n*     }\n* }\n*\n* function bar( resolve ) {\n*     setTimeout( onTimeout, 100 );\n*     function onTimeout() {\n*         resolve( null, 'two' );\n*     }\n* }\n*\n* function done( error, results ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( results );\n*     // => [ 'one', 'two' ]\n* }\n*\n* var fcns = [ foo, bar ];\n*\n* parallel( fcns, done );\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAoB,QAAS,oCAAqC,EAAE,YACpEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMN,EAAUM,CAAQ,GAGnBL,EAAYK,EAAS,SAAU,IACnCD,EAAK,QAAUC,EAAQ,SAEnBL,EAAYK,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACJ,EAAmBG,EAAK,KAAM,GAC5B,IAAI,UAAWF,EAAQ,wEAAyE,QAASE,EAAK,KAAM,CAAE,EAGxH,MAXC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAYhH,CAKAP,EAAO,QAAUK,ICtEjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,OAAQ,EAK1BC,EAAQD,EAAQ,sBAAuB,EAgB3C,SAASE,EAAOC,EAAMC,EAAMC,EAAO,CAClC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAgBJ,IAdAH,EAAMP,EAAK,OACXF,EAAO,0BAA2BS,CAAI,EAEtCE,EAAM,IAAI,MAAOF,CAAI,EAChBA,EAAMN,EAAK,MACfK,EAAMC,EAEND,EAAML,EAAK,MAEZH,EAAO,wBAAyBQ,CAAI,EAEpCH,EAAWI,EAAM,EACjBH,EAAQ,EACRI,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKI,IAEhBF,EAAML,GACVQ,EAAK,EAQP,SAASA,GAAO,CACf,IAAID,EAEJF,GAAO,EAGPE,EAAIF,EAEJR,EAAMQ,CAAI,EAAE,KAAMP,EAAK,QAASW,CAAQ,EAUxC,SAASA,EAASC,EAAOC,EAAU,CAClC,GAAK,CAAAT,EAIL,IAAKQ,EACJ,OAAAR,EAAM,GACCU,EAAMF,CAAM,EAEpBJ,EAAKC,CAAE,EAAII,EACXC,EAAK,EACN,CACD,CASA,SAASA,EAAMF,EAAQ,CACtB,GAAKA,EACJ,OAAAf,EAAO,2BAA4Be,EAAM,OAAQ,EAC1CX,EAAMW,CAAM,EAIpB,GAFAT,GAAS,EACTN,EAAO,gCAAiCM,EAAOG,CAAI,EAC9CC,EAAML,EACV,OAAOQ,EAAK,EAEb,GAAKP,IAAUG,EACd,OAAAT,EAAO,oCAAqC,EACrCI,EAAM,KAAMO,CAAI,CAEzB,CACD,CAKAb,EAAO,QAAUG,ICzIjB,IAAAiB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAkB,QAAS,kCAAmC,EAC9DC,EAAa,QAAS,4BAA6B,EACnDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAO,QAAS,gCAAiC,EACjDC,EAAW,IACXC,EAAQ,IA8CZ,SAASC,EAASC,EAAMC,EAAU,CACjC,IAAIC,EACAC,EAEJ,GAAK,CAACV,EAAiBO,CAAK,EAC3B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAK,CAAE,EAKrH,GAHAE,EAAO,CACN,MAASN,CACV,EACK,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,OAAOC,EAUP,SAASA,EAAUC,EAAO,CACzB,GAAK,CAACX,EAAYW,CAAK,EACtB,MAAM,IAAI,UAAWV,EAAQ,uEAAwEU,CAAK,CAAE,EAE7G,OAAOP,EAAOE,EAAME,EAAMI,CAAK,EAU/B,SAASA,EAAMC,EAAOC,EAAM,CAC3B,GAAKD,EACJ,OAAOF,EAAME,CAAM,EAEpBF,EAAM,KAAMG,CAAI,CACjB,CACD,CACD,CAKAhB,EAAO,QAAUO,IC7HjB,IAAAU,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA8Cd,SAASC,EAAUC,EAAMC,EAASC,EAAO,CACxC,GAAK,UAAU,OAAS,EACvB,OAAOJ,EAASE,CAAK,EAAGC,CAAQ,EAEjCH,EAASE,EAAMC,CAAQ,EAAGC,CAAK,CAChC,CAKAL,EAAO,QAAUE,ICrBjB,IAAII,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
   "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isPositiveInteger", "format", "validate", "opts", "options", "require_limit", "__commonJSMin", "exports", "module", "logger", "debug", "limit", "fcns", "opts", "done", "maxIndex", "count", "flg", "lim", "len", "idx", "out", "i", "next", "resolve", "error", "results", "clbk", "require_factory", "__commonJSMin", "exports", "module", "isFunctionArray", "isFunction", "format", "PINF", "validate", "limit", "factory", "fcns", "options", "opts", "err", "parallel", "done", "clbk", "error", "out", "require_main", "__commonJSMin", "exports", "module", "factory", "parallel", "fcns", "options", "done", "setReadOnly", "main", "factory"]
 }

package/docs/types/index.d.ts

@@ -80,8 +80,6 @@ interface Parallel {
 	* @param clbk - callback to invoke upon completion
 	*
 	* @example
-	* var parallel = require( '@stdlib/utils-async-parallel' );
-	*
 	* function foo( clbk ) {
 	*     setTimeout( onTimeout, 300 );
 	*     function onTimeout() {
@@ -107,8 +105,8 @@ interface Parallel {
 	* var fcns = [ foo, bar ];
 	*
 	* var opts = {
-	* 	'thisArg': {},
-	* 	'limit': 2
+	*     'thisArg': {},
+	*     'limit': 2
 	* }
 	*
 	* parallel( fcns, opts, done );
@@ -218,8 +216,8 @@ interface Parallel {
 	* var fcns = [ a, b ];
 	*
 	* var opts = {
-	* 	'thisArg': {},
-	* 	'limit': 2
+	*     'thisArg': {},
+	*     'limit': 2
 	* }
 	*
 	* var run = parallel.factory( fcns, opts );
@@ -246,8 +244,6 @@ interface Parallel {
 * @param clbk - callback to invoke upon completion
 *
 * @example
-* var parallel = require( '@stdlib/utils-async-parallel' );
-*
 * function foo( clbk ) {
 *     setTimeout( onTimeout, 300 );
 *     function onTimeout() {

package/lib/limit.js

@@ -54,7 +54,7 @@ function limit( fcns, opts, done ) {
 	len = fcns.length;
 	debug( 'Number of functions: %d', len );
 
-	out = new Array( len );
+	out = new Array( len ); // eslint-disable-line stdlib/no-new-array
 	if ( len < opts.limit ) {
 		lim = len;
 	} else {

package/lib/main.js

@@ -40,8 +40,6 @@ var factory = require( './factory.js' );
 * @returns {void}
 *
 * @example
-* var parallel = require( '@stdlib/utils-async-parallel' );
-*
 * function foo( resolve ) {
 *     setTimeout( onTimeout, 300 );
 *     function onTimeout() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-async-parallel",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Execute a set of functions in parallel.",
   "license": "Apache-2.0",
   "author": {
@@ -30,16 +30,16 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.2.2",
-    "@stdlib/assert-is-function": "^0.2.2",
-    "@stdlib/assert-is-function-array": "^0.2.1",
-    "@stdlib/assert-is-plain-object": "^0.2.2",
-    "@stdlib/assert-is-positive-integer": "^0.2.2",
-    "@stdlib/constants-float64-pinf": "^0.2.2",
-    "@stdlib/string-format": "^0.2.2",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2",
+    "@stdlib/assert-has-own-property": "^0.2.3",
+    "@stdlib/assert-is-function": "^0.2.3",
+    "@stdlib/assert-is-function-array": "^0.2.2",
+    "@stdlib/assert-is-plain-object": "^0.2.3",
+    "@stdlib/assert-is-positive-integer": "^0.2.3",
+    "@stdlib/constants-float64-pinf": "^0.2.3",
+    "@stdlib/string-format": "^0.2.3",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3",
     "debug": "^2.6.9",
-    "@stdlib/error-tools-fmtprodmsg": "^0.2.2"
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.3"
   },
   "devDependencies": {},
   "engines": {