@stdlib/utils-async-inmap-right 0.0.8 → 0.2.0

package/LICENSE

@@ -175,307 +175,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by this
-license (the "Software") to use, reproduce, display, distribute, execute, and
-transmit the Software, and to prepare derivative works of the Software, and to
-permit third-parties to whom the Software is furnished to do so, all subject to
-the following:
-
-The copyright notices in the Software and this entire statement, including the
-above license grant, this restriction and the following disclaimer, must be
-included in all copies of the Software, in whole or in part, and all derivative
-works of the Software, unless such copies or derivative works are solely in the
-form of machine-executable object code generated by a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES
-OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
-OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-
-
-DEPENDENCIES
-
-The library links against the following external libraries, which have their own
-licenses:
-
-* OpenBLAS <https://raw.githubusercontent.com/xianyi/OpenBLAS/
-def146efed8d5908ea04e22668feeab7099599a0/LICENSE>
-
-Copyright (c) 2011-2014, The OpenBLAS Project
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   1. Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-
-   2. Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in
-      the documentation and/or other materials provided with the
-      distribution.
-
-   3. Neither the name of the OpenBLAS project nor the names of
-      its contributors may be used to endorse or promote products
-      derived from this software without specific prior written
-      permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
-THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-* Electron <https://raw.githubusercontent.com/electron/electron/
-c4cfb3e7110266b9d7ad80e1ae097c4db564501c/LICENSE>
-
-Copyright (c) 2013-2017 GitHub Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-* Boost <http://www.boost.org/LICENSE_1_0.txt>
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by
-this license (the "Software") to use, reproduce, display, distribute,
-execute, and transmit the Software, and to prepare derivative works of the
-Software, and to permit third-parties to whom the Software is furnished to
-do so, all subject to the following:
-
-The copyright notices in the Software and this entire statement, including
-the above license grant, this restriction and the following disclaimer,
-must be included in all copies of the Software, in whole or in part, and
-all derivative works of the Software, unless such copies or derivative
-works are solely in the form of machine-executable object code generated by
-a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
-SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
-FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
-
-
-* Cephes <http://www.netlib.org/cephes/readme>
-
-Copyright (c) 1984-2000 Stephen L. Moshier
-
-Some software in this archive may be from the book _Methods and Programs for
-Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989)
-or from the Cephes Mathematical Library, a commercial product. In either event,
-it is copyrighted by the author. What you see here may be used freely but it
-comes with no support or guarantee.
-
-Stephen L. Moshier
-moshier@na-net.ornl.gov
-
-
-
-ATTRIBUTION
-
-The library contains implementations from the following external libraries,
-which have their own licenses:
-
-* FreeBSD <https://svnweb.freebsd.org/>
-
-Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved.
-
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-
-
-* FDLIBM <http://www.netlib.org/fdlibm/>
-
-Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
-
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-
-
-* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
-
-Copyright (c) 2009 The Go Authors. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   * Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above
-copyright notice, this list of conditions and the following disclaimer
-in the documentation and/or other materials provided with the
-distribution.
-   * Neither the name of Google Inc. nor the names of its
-contributors may be used to endorse or promote products derived from
-this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-* SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>
-
-Public domain.
-
-
-* ESLint <https://raw.githubusercontent.com/eslint/eslint/master/LICENSE>
-
-Copyright JS Foundation and other contributors, https://js.foundation
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-
-* StatsFuns.jl <https://raw.githubusercontent.com/JuliaStats/StatsFuns.jl/
-e66dd973650c375bc1739c820e5b96bb5bd000a8/LICENSE.md>
-
-Copyright (c) 2015: Dahua Lin.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-* SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
-SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
-
-The MIT License (MIT)
-
-Copyright (c) 2017 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others:
-
-https://github.com/JuliaMath/SpecialFunctions.jl/graphs/contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
-* MT19937 <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/
-mt19937ar.c>
-
-Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
- 1. Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-
- 2. Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
-
- 3. The names of its contributors may not be used to endorse or promote
-    products derived from this software without specific prior written
-    permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/NOTICE

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

package/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] -->
@@ -138,9 +149,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`.
 
@@ -258,10 +269,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.
 
@@ -302,7 +313,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 ) {
@@ -430,9 +441,9 @@ inmapRightAsync( files, read, done );
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/utils/async/for-each-right`][@stdlib/utils/async/for-each-right]</span><span class="delimiter">: </span><span class="description">invoke a function once for each element in a collection, iterating from right to left.</span>
--   <span class="package-name">[`@stdlib/utils/async/inmap`][@stdlib/utils/async/inmap]</span><span class="delimiter">: </span><span class="description">invoke a function for each element in a collection and update the collection in-place.</span>
--   <span class="package-name">[`@stdlib/utils/inmap-right`][@stdlib/utils/inmap-right]</span><span class="delimiter">: </span><span class="description">invoke a function for each element in a collection and update the collection in-place, iterating from right to left.</span>
+-   <span class="package-name">[`@stdlib/utils-async/for-each-right`][@stdlib/utils/async/for-each-right]</span><span class="delimiter">: </span><span class="description">invoke a function once for each element in a collection, iterating from right to left.</span>
+-   <span class="package-name">[`@stdlib/utils-async/inmap`][@stdlib/utils/async/inmap]</span><span class="delimiter">: </span><span class="description">invoke a function for each element in a collection and update the collection in-place.</span>
+-   <span class="package-name">[`@stdlib/utils-inmap-right`][@stdlib/utils/inmap-right]</span><span class="delimiter">: </span><span class="description">invoke a function for each element in a collection and update the collection in-place, iterating from right to left.</span>
 
 </section>
 
@@ -464,7 +475,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -477,8 +488,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/utils-async-inmap-right.svg
 [npm-url]: https://npmjs.org/package/@stdlib/utils-async-inmap-right
 
-[test-image]: https://github.com/stdlib-js/utils-async-inmap-right/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/utils-async-inmap-right/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/utils-async-inmap-right/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/utils-async-inmap-right/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-async-inmap-right/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/utils-async-inmap-right?branch=main
@@ -490,19 +501,23 @@ Copyright &copy; 2016-2022. 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
+
+[stdlib]: https://github.com/stdlib-js/stdlib
+
+[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+
 [umd]: https://github.com/umdjs/umd
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/utils-async-inmap-right/tree/deno
+[deno-readme]: https://github.com/stdlib-js/utils-async-inmap-right/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/utils-async-inmap-right/tree/umd
+[umd-readme]: https://github.com/stdlib-js/utils-async-inmap-right/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/utils-async-inmap-right/tree/esm
-
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
-
-[stdlib]: https://github.com/stdlib-js/stdlib
-
-[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+[esm-readme]: https://github.com/stdlib-js/utils-async-inmap-right/blob/esm/README.md
+[branches-url]: https://github.com/stdlib-js/utils-async-inmap-right/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async-inmap-right/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/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var p=g(function(U,A){
+var N=require('@stdlib/assert-is-plain-object/dist'),c=require('@stdlib/assert-has-own-property/dist'),R=require('@stdlib/assert-is-boolean/dist').isPrimitive,k=require('@stdlib/assert-is-positive-integer/dist').isPrimitive,o=require('@stdlib/error-tools-fmtprodmsg/dist');function I(e,r){return N(r)?(c(r,"thisArg")&&(e.thisArg=r.thisArg),c(r,"series")&&(e.series=r.series,!R(e.series))?new TypeError(o('1RJ2o',"series",e.series)):c(r,"limit")&&(e.limit=r.limit,!k(e.limit))?new TypeError(o('1RJ3P',"limit",e.limit)):null):new TypeError(o('1RJ2V',r));}A.exports=I
+});var E=g(function(W,x){
+var L=require("debug"),l=L("inmap-right-async:limit");function B(e,r,i,s){var n,v,u,t,m,f;if(t=e.length,l("Collection length: %d",t),t===0)return l("Finished processing a collection."),s();for(t<r.limit?u=t:u=r.limit,l("Concurrency limit: %d",u),l("Number of arguments: %d",i.length),n=0,m=t,f=0;f<u;f++)m>0&&y();function y(){var a;m-=1,a=m,l("Collection element %d: %s.",a,JSON.stringify(e[a])),i.length===2?i.call(r.thisArg,e[a],h):i.length===3?i.call(r.thisArg,e[a],a,h):i.call(r.thisArg,e[a],a,e,h);function h(w,j){if(!v){if(w)return v=!0,b(w);e[a]=j,b()}}}function b(a){if(a)return l("Encountered an error: %s",a.message),s(a);if(n+=1,l("Processed %d of %d collection elements.",n,t),m>0)return y();if(n===t)return l("Finished processing a collection."),s()}}x.exports=B
+});var q=g(function(X,P){
+var O=require('@stdlib/assert-is-function/dist'),J=require('@stdlib/assert-is-collection/dist'),d=require('@stdlib/error-tools-fmtprodmsg/dist'),S=require('@stdlib/constants-float64-pinf/dist'),z=p(),D=E();function G(e,r){var i,s,n;if(i={},arguments.length>1){if(s=z(i,e),s)throw s;n=r}else n=e;if(!O(n))throw new TypeError(d('1RJ3q',n));return i.series?i.limit=1:i.limit||(i.limit=S),v;function v(u,t){if(!J(u))throw new TypeError(d('1RJAh',u));if(!O(t))throw new TypeError(d('1RJ3q',t));return D(u,i,n,m);function m(f){if(f)return t(f,u);t(null,u)}}}P.exports=G
+});var C=g(function(Y,F){
+var T=q();function H(e,r,i,s){if(arguments.length<4)return T(r)(e,i);T(r,i)(e,s)}F.exports=H
+});var K=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),V=C(),M=q();K(V,"factory",M);module.exports=V;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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) 2018 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 isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive;\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* @param {boolean} [options.series] - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n*     'thisArg': {},\n*     'series': false,\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, 'series' ) ) {\n\t\topts.series = options.series;\n\t\tif ( !isBoolean( opts.series ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'series', opts.series ) );\n\t\t}\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) 2018 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( 'inmap-right-async:limit' );\n\n\n// MAIN //\n\n/**\n* Invokes a function once for each element in a collection, limiting the number of concurrently pending functions and iterating from right to left, and updates a collection in-place.\n*\n* @private\n* @param {Collection} collection - input collection\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 {Function} fcn - function to invoke\n* @param {Callback} done - function to invoke upon completion or upon encountering an error\n* @returns {void}\n*/\nfunction limit( collection, opts, fcn, done ) {\n\tvar count;\n\tvar flg;\n\tvar lim;\n\tvar len;\n\tvar idx;\n\tvar i;\n\n\tlen = collection.length;\n\tdebug( 'Collection length: %d', len );\n\n\tif ( len === 0 ) {\n\t\tdebug( 'Finished processing a collection.' );\n\t\treturn done();\n\t}\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\tdebug( 'Number of arguments: %d', fcn.length );\n\n\tcount = 0;\n\tidx = len;\n\tfor ( i = 0; i < lim; i++ ) {\n\t\t// This guard is necessary to protect against synchronous functions which exhaust all collection elements...\n\t\tif ( idx > 0 ) {\n\t\t\tnext(); // eslint-disable-line node/callback-return\n\t\t}\n\t}\n\t/**\n\t* Callback to invoke a provided function for the next element in a collection.\n\t*\n\t* @private\n\t*/\n\tfunction next() {\n\t\tvar j;\n\t\tidx -= 1;\n\t\tj = idx;\n\t\tdebug( 'Collection element %d: %s.', j, JSON.stringify( collection[ j ] ) );\n\t\tif ( fcn.length === 2 ) {\n\t\t\tfcn.call( opts.thisArg, collection[ j ], cb );\n\t\t} else if ( fcn.length === 3 ) {\n\t\t\tfcn.call( opts.thisArg, collection[ j ], j, cb );\n\t\t} else {\n\t\t\tfcn.call( opts.thisArg, collection[ j ], j, collection, cb );\n\t\t}\n\t\t/**\n\t\t* Callback invoked once a provided function finishes processing a collection element.\n\t\t*\n\t\t* @private\n\t\t* @param {*} [error] - error\n\t\t* @param {*} [result] - result\n\t\t* @returns {void}\n\t\t*/\n\t\tfunction cb( error, result ) {\n\t\t\tif ( flg ) {\n\t\t\t\t// Prevent further processing of collection elements:\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\tcollection[ j ] = result;\n\t\t\tclbk();\n\t\t}\n\t}\n\n\t/**\n\t* Callback invoked once ready to process the next collection element.\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 collection elements.', count, len );\n\t\tif ( idx > 0 ) {\n\t\t\treturn next();\n\t\t}\n\t\tif ( count === len ) {\n\t\t\tdebug( 'Finished processing a collection.' );\n\t\t\treturn done();\n\t\t}\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = limit;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 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 isFunction = require( '@stdlib/assert-is-function' );\nvar isCollection = require( '@stdlib/assert-is-collection' );\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 invoke a function once for each element in a collection and to update the collection in-place, iterating from right to left.\n*\n* ## Notes\n*\n* -   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.\n* -   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`).\n*\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 {boolean} [options.series=false] - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection\n* @param {Function} fcn - function to invoke for each element in a collection\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {TypeError} last argument must be a function\n* @returns {Function} function which invokes the provided function once for each element in a collection\n*\n* @example\n* var readFile = require( '@stdlib/fs-read-file' );\n*\n* function read( file, next ) {\n*     var opts = {\n*         'encoding': 'utf8'\n*     };\n*     readFile( file, opts, onFile );\n*\n*     function onFile( error, data ) {\n*         if ( error ) {\n*             return next( error );\n*         }\n*         next( null, data );\n*     }\n* }\n*\n* var opts = {\n*     'series': true\n* };\n*\n* // Create a `inmapRightAsync` function which invokes `read` for each collection element sequentially:\n* var inmapRightAsync = factory( opts, read );\n*\n* // Create a collection over which to iterate:\n* var files = [\n*     './beep.js',\n*     './boop.js'\n* ];\n*\n* // Define a callback which handles errors:\n* function done( error, results ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( results );\n* }\n*\n* // Run `read` for each element in `files`:\n* inmapRightAsync( files, done );\n*/\nfunction factory( options, fcn ) {\n\tvar opts;\n\tvar err;\n\tvar f;\n\n\topts = {};\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\tf = fcn;\n\t} else {\n\t\tf = options;\n\t}\n\tif ( !isFunction( f ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', f ) );\n\t}\n\tif ( opts.series ) {\n\t\topts.limit = 1;\n\t} else if ( !opts.limit ) {\n\t\topts.limit = PINF;\n\t}\n\treturn inmapRightAsync;\n\n\t/**\n\t* Invokes a function for each element in a collection and updates a collection in-place, iterating from right to left.\n\t*\n\t* @private\n\t* @param {Collection} collection - input collection\n\t* @param {Callback} done - function to invoke upon completion\n\t* @throws {TypeError} first argument must be a collection\n\t* @throws {TypeError} last argument must be a function\n\t* @returns {void}\n\t*/\n\tfunction inmapRightAsync( collection, done ) {\n\t\tif ( !isCollection( collection ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a collection. Value: `%s`.', collection ) );\n\t\t}\n\t\tif ( !isFunction( done ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', done ) );\n\t\t}\n\t\treturn limit( collection, opts, f, 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* @returns {void}\n\t\t*/\n\t\tfunction clbk( error ) {\n\t\t\tif ( error ) {\n\t\t\t\treturn done( error, collection );\n\t\t\t}\n\t\t\tdone( null, collection );\n\t\t}\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 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* Invokes a function once for each element in a collection and updates a collection in-place, iterating from right to left.\n*\n* ## Notes\n*\n* -   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.\n* -   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`).\n*\n* @param {Collection} collection - input collection\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 {boolean} [options.series=false] - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection\n* @param {Function} fcn - function to invoke for each element in a collection\n* @param {Callback} done - function to invoke upon completion\n* @throws {TypeError} first argument must be a collection\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {TypeError} second-to-last argument must be a function\n* @throws {TypeError} last argument must be a function\n* @returns {void}\n*\n* @example\n* var readFile = require( '@stdlib/fs-read-file' );\n*\n* function done( error, results ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( results );\n* }\n*\n* function read( file, next ) {\n*     var opts = {\n*         'encoding': 'utf8'\n*     };\n*     readFile( file, opts, onFile );\n*\n*     function onFile( error, data ) {\n*         if ( error ) {\n*             return next( error );\n*         }\n*         next( null, data );\n*     }\n* }\n*\n* var files = [\n*     './beep.js',\n*     './boop.js'\n* ];\n*\n* inmapRightAsync( files, read, done );\n*/\nfunction inmapRightAsync( collection, options, fcn, done ) {\n\tif ( arguments.length < 4 ) {\n\t\treturn factory( options )( collection, fcn );\n\t}\n\tfactory( options, fcn )( collection, done );\n}\n\n\n// EXPORTS //\n\nmodule.exports = inmapRightAsync;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 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* Invoke a function once for each element in a collection and update a collection in-place, iterating from right to left.\n*\n* @module @stdlib/utils-async-inmap-right\n*\n* @example\n* var readFile = require( '@stdlib/fs-read-file' );\n* var inmapRightAsync = require( '@stdlib/utils-async-inmap-right' );\n*\n* var files = [\n*     './beep.js',\n*     './boop.js'\n* ];\n*\n* function done( error, results ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( results );\n* }\n*\n* function read( file, next ) {\n*     var opts = {\n*         'encoding': 'utf8'\n*     };\n*     readFile( file, opts, onFile );\n*\n*     function onFile( error, data ) {\n*         if ( error ) {\n*             error = new Error( 'unable to read file: '+file );\n*             return next( error );\n*         }\n*         next( null, data );\n*     }\n* }\n*\n* inmapRightAsync( files, read, 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,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAoB,QAAS,oCAAqC,EAAE,YACpEC,EAAS,QAAS,uBAAwB,EA4B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,GAGnBN,EAAYM,EAAS,SAAU,IACnCD,EAAK,QAAUC,EAAQ,SAEnBN,EAAYM,EAAS,QAAS,IAClCD,EAAK,OAASC,EAAQ,OACjB,CAACL,EAAWI,EAAK,MAAO,GACrB,IAAI,UAAWF,EAAQ,+DAAgE,SAAUE,EAAK,MAAO,CAAE,EAGnHL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACJ,EAAmBG,EAAK,KAAM,GAC5B,IAAI,UAAWF,EAAQ,wEAAyE,QAASE,EAAK,KAAM,CAAE,EAGxH,MAjBC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAkBhH,CAKAR,EAAO,QAAUM,IC/EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,OAAQ,EAK1BC,EAAQD,EAAQ,yBAA0B,EAiB9C,SAASE,EAAOC,EAAYC,EAAMC,EAAKC,EAAO,CAC7C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAF,EAAMP,EAAW,OACjBF,EAAO,wBAAyBS,CAAI,EAE/BA,IAAQ,EACZ,OAAAT,EAAO,mCAAoC,EACpCK,EAAK,EAYb,IAVKI,EAAMN,EAAK,MACfK,EAAMC,EAEND,EAAML,EAAK,MAEZH,EAAO,wBAAyBQ,CAAI,EACpCR,EAAO,0BAA2BI,EAAI,MAAO,EAE7CE,EAAQ,EACRI,EAAMD,EACAE,EAAI,EAAGA,EAAIH,EAAKG,IAEhBD,EAAM,GACVE,EAAK,EAQP,SAASA,GAAO,CACf,IAAIC,EACJH,GAAO,EACPG,EAAIH,EACJV,EAAO,6BAA8Ba,EAAG,KAAK,UAAWX,EAAYW,CAAE,CAAE,CAAE,EACrET,EAAI,SAAW,EACnBA,EAAI,KAAMD,EAAK,QAASD,EAAYW,CAAE,EAAGC,CAAG,EACjCV,EAAI,SAAW,EAC1BA,EAAI,KAAMD,EAAK,QAASD,EAAYW,CAAE,EAAGA,EAAGC,CAAG,EAE/CV,EAAI,KAAMD,EAAK,QAASD,EAAYW,CAAE,EAAGA,EAAGX,EAAYY,CAAG,EAU5D,SAASA,EAAIC,EAAOC,EAAS,CAC5B,GAAK,CAAAT,EAIL,IAAKQ,EACJ,OAAAR,EAAM,GACCU,EAAMF,CAAM,EAEpBb,EAAYW,CAAE,EAAIG,EAClBC,EAAK,EACN,CACD,CASA,SAASA,EAAMF,EAAQ,CACtB,GAAKA,EACJ,OAAAf,EAAO,2BAA4Be,EAAM,OAAQ,EAC1CV,EAAMU,CAAM,EAIpB,GAFAT,GAAS,EACTN,EAAO,0CAA2CM,EAAOG,CAAI,EACxDC,EAAM,EACV,OAAOE,EAAK,EAEb,GAAKN,IAAUG,EACd,OAAAT,EAAO,mCAAoC,EACpCK,EAAK,CAEd,CACD,CAKAP,EAAO,QAAUG,IC7IjB,IAAAiB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAa,QAAS,4BAA6B,EACnDC,EAAe,QAAS,8BAA+B,EACvDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAO,QAAS,gCAAiC,EACjDC,EAAW,IACXC,EAAQ,IAgEZ,SAASC,EAASC,EAASC,EAAM,CAChC,IAAIC,EACAC,EACAC,EAGJ,GADAF,EAAO,CAAC,EACH,UAAU,OAAS,EAAI,CAE3B,GADAC,EAAMN,EAAUK,EAAMF,CAAQ,EACzBG,EACJ,MAAMA,EAEPC,EAAIH,CACL,MACCG,EAAIJ,EAEL,GAAK,CAACP,EAAYW,CAAE,EACnB,MAAM,IAAI,UAAWT,EAAQ,mEAAoES,CAAE,CAAE,EAEtG,OAAKF,EAAK,OACTA,EAAK,MAAQ,EACDA,EAAK,QACjBA,EAAK,MAAQN,GAEPS,EAYP,SAASA,EAAiBC,EAAYC,EAAO,CAC5C,GAAK,CAACb,EAAcY,CAAW,EAC9B,MAAM,IAAI,UAAWX,EAAQ,sEAAuEW,CAAW,CAAE,EAElH,GAAK,CAACb,EAAYc,CAAK,EACtB,MAAM,IAAI,UAAWZ,EAAQ,mEAAoEY,CAAK,CAAE,EAEzG,OAAOT,EAAOQ,EAAYJ,EAAME,EAAGI,CAAK,EASxC,SAASA,EAAMC,EAAQ,CACtB,GAAKA,EACJ,OAAOF,EAAME,EAAOH,CAAW,EAEhCC,EAAM,KAAMD,CAAW,CACxB,CACD,CACD,CAKAd,EAAO,QAAUO,IC1JjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA0Dd,SAASC,EAAiBC,EAAYC,EAASC,EAAKC,EAAO,CAC1D,GAAK,UAAU,OAAS,EACvB,OAAOL,EAASG,CAAQ,EAAGD,EAAYE,CAAI,EAE5CJ,EAASG,EAASC,CAAI,EAAGF,EAAYG,CAAK,CAC3C,CAKAN,EAAO,QAAUE,IC7BjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isBoolean", "isPositiveInteger", "format", "validate", "opts", "options", "require_limit", "__commonJSMin", "exports", "module", "logger", "debug", "limit", "collection", "opts", "fcn", "done", "count", "flg", "lim", "len", "idx", "i", "next", "j", "cb", "error", "result", "clbk", "require_factory", "__commonJSMin", "exports", "module", "isFunction", "isCollection", "format", "PINF", "validate", "limit", "factory", "options", "fcn", "opts", "err", "f", "inmapRightAsync", "collection", "done", "clbk", "error", "require_main", "__commonJSMin", "exports", "module", "factory", "inmapRightAsync", "collection", "options", "fcn", "done", "setReadOnly", "main", "factory"]
+}

package/docs/types/index.d.ts

@@ -16,43 +16,43 @@
 * 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.
@@ -60,7 +60,7 @@ type DoneUnary = ( error: Error ) => void;
 * @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.
@@ -68,15 +68,14 @@ type DoneBinary = ( error: Error, collection: Collection ) => void;
 * @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.
@@ -84,7 +83,7 @@ type Unary = ( error: Error ) => void;
 * @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.
@@ -92,7 +91,7 @@ type Binary = ( error: Error | null, result: any ) => void;
 * @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.
@@ -100,7 +99,7 @@ type Callback = Unary | Binary;
 * @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,7 +128,7 @@ 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.
@@ -137,7 +136,7 @@ type Fcn = BinaryFcn | TernaryFcn | QuaternaryFcn;
 * @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
@@ -162,7 +160,7 @@ interface InMapRightAsync {
 	* @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 ) {
@@ -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,13 +200,12 @@ 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
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error, results ) {
 	*     if ( error ) {
@@ -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;
 
 	/**
 	* 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
@@ -258,7 +254,7 @@ interface InMapRightAsync {
 	* @returns function which invokes the provided function once for each element in a collection
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function read( file, next ) {
 	*     var opts = {
@@ -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,13 +304,12 @@ 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
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function read( file, next ) {
 	*     var opts = {
@@ -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>;
 }
 
 /**
@@ -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
@@ -372,7 +366,7 @@ interface InMapRightAsync {
 * @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 ) {

package/lib/factory.js

@@ -22,6 +22,7 @@
 
 var isFunction = require( '@stdlib/assert-is-function' );
 var isCollection = require( '@stdlib/assert-is-collection' );
+var format = require( '@stdlib/string-format' );
 var PINF = require( '@stdlib/constants-float64-pinf' );
 var validate = require( './validate.js' );
 var limit = require( './limit.js' );
@@ -37,7 +38,6 @@ var limit = require( './limit.js' );
 * -   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} [options] - function options
 * @param {*} [options.thisArg] - execution context
 * @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time
@@ -105,7 +105,7 @@ function factory( options, fcn ) {
 		f = options;
 	}
 	if ( !isFunction( f ) ) {
-		throw new TypeError( 'invalid argument. Last argument must be a function. Value: `'+f+'`.' );
+		throw new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', f ) );
 	}
 	if ( opts.series ) {
 		opts.limit = 1;
@@ -126,10 +126,10 @@ function factory( options, fcn ) {
 	*/
 	function inmapRightAsync( collection, done ) {
 		if ( !isCollection( collection ) ) {
-			throw new TypeError( 'invalid argument. First argument must be a collection. Value: `'+collection+'.`' );
+			throw new TypeError( format( 'invalid argument. First argument must be a collection. Value: `%s`.', collection ) );
 		}
 		if ( !isFunction( done ) ) {
-			throw new TypeError( 'invalid argument. Last argument must be a function. Value: `'+done+'`.' );
+			throw new TypeError( format( 'invalid argument. Last argument must be a function. Value: `%s`.', done ) );
 		}
 		return limit( collection, opts, f, clbk );
 

package/lib/index.js

@@ -60,15 +60,15 @@
 // MODULES //
 
 var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var inmapRightAsync = require( './inmap_right.js' );
+var main = require( './main.js' );
 var factory = require( './factory.js' );
 
 
 // MAIN //
 
-setReadOnly( inmapRightAsync, 'factory', factory );
+setReadOnly( main, 'factory', factory );
 
 
 // EXPORTS //
 
-module.exports = inmapRightAsync;
+module.exports = main;

package/lib/{inmap_right.js → main.js}

@@ -33,7 +33,6 @@ var factory = require( './factory.js' );
 * -   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} collection - input collection
 * @param {Options} [options] - function options
 * @param {*} [options.thisArg] - execution context

package/lib/validate.js

@@ -24,6 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' );
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive;
 var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive;
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -53,7 +54,7 @@ var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimit
 */
 function validate( opts, options ) {
 	if ( !isObject( options ) ) {
-		return new TypeError( 'invalid argument. Options must be an object. Value: `' + options + '`.' );
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'thisArg' ) ) {
 		opts.thisArg = options.thisArg;
@@ -61,13 +62,13 @@ function validate( opts, options ) {
 	if ( hasOwnProp( options, 'series' ) ) {
 		opts.series = options.series;
 		if ( !isBoolean( opts.series ) ) {
-			return new TypeError( 'invalid option. `series` option must be a boolean primitive. Option: `' + opts.series + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'series', opts.series ) );
 		}
 	}
 	if ( hasOwnProp( options, 'limit' ) ) {
 		opts.limit = options.limit;
 		if ( !isPositiveInteger( opts.limit ) ) {
-			return new TypeError( 'invalid option. `limit` option must be a positive integer. Option: `' + opts.limit + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a positive integer. Option: `%s`.', 'limit', opts.limit ) );
 		}
 	}
 	return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-async-inmap-right",
-  "version": "0.0.8",
+  "version": "0.2.0",
   "description": "Invoke a function for each element in a collection and update the collection in-place, iterating from right to left.",
   "license": "Apache-2.0",
   "author": {
@@ -37,25 +37,28 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.0.x",
-    "@stdlib/assert-is-boolean": "^0.0.x",
-    "@stdlib/assert-is-collection": "^0.0.x",
-    "@stdlib/assert-is-function": "^0.0.x",
-    "@stdlib/assert-is-plain-object": "^0.0.x",
-    "@stdlib/assert-is-positive-integer": "^0.0.x",
-    "@stdlib/constants-float64-pinf": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
-    "debug": "^2.6.9"
+    "@stdlib/assert-has-own-property": "^0.1.1",
+    "@stdlib/assert-is-boolean": "^0.2.0",
+    "@stdlib/assert-is-collection": "^0.2.0",
+    "@stdlib/assert-is-function": "^0.2.0",
+    "@stdlib/assert-is-plain-object": "^0.2.0",
+    "@stdlib/assert-is-positive-integer": "^0.2.0",
+    "@stdlib/constants-float64-pinf": "^0.2.0",
+    "@stdlib/string-format": "^0.2.0",
+    "@stdlib/types": "^0.3.1",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0",
+    "debug": "^2.6.9",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.1"
   },
   "devDependencies": {
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/constants-float64-eps": "^0.0.x",
-    "@stdlib/fs-read-file": "^0.0.x",
-    "@stdlib/utils-noop": "^0.0.x",
+    "@stdlib/constants-float64-eps": "^0.1.1",
+    "@stdlib/fs-read-file": "^0.1.1",
+    "@stdlib/utils-noop": "^0.2.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
+    "@stdlib/bench-harness": "^0.1.2",
+    "@stdlib/bench": "^0.3.1"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -94,7 +97,7 @@
     "async"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,209 +0,0 @@
-
-{{alias}}( collection, [options,] fcn, done )
-    Invokes a function once for each element in a collection and updates a
-    collection in-place, iterating from right to left.
-
-    When invoked, `fcn` is provided a maximum of four arguments:
-
-    - `value`: collection value
-    - `index`: collection index
-    - `collection`: the input collection
-    - `next`: a callback to be invoked after processing a collection `value`
-
-    The actual number of provided arguments depends on function length. If `fcn`
-    accepts two arguments, `fcn` is provided:
-
-    - `value`
-    - `next`
-
-    If `fcn` accepts three arguments, `fcn` is provided:
-
-    - `value`
-    - `index`
-    - `next`
-
-    For every other `fcn` signature, `fcn` is provided all four arguments.
-
-    The `next` callback accepts two arguments:
-
-    - `error`: error argument
-    - `result`: value used to update the collection
-
-    If a provided function calls the `next` 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.
-
-    Execution is *not* guaranteed to be asynchronous. To guarantee asynchrony,
-    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`).
-
-    The function does not support dynamic collection resizing.
-
-    The function does not skip `undefined` elements.
-
-    Parameters
-    ----------
-    collection: Array|TypedArray|Object
-        Input collection over which to iterate. If provided an object, the
-        object must be array-like (excluding strings and functions).
-
-    options: Object (optional)
-        Function options.
-
-    options.limit: integer (optional)
-        Maximum number of pending invocations. Default: Infinity.
-
-    options.series: boolean (optional)
-        Boolean indicating whether to process each collection element
-        sequentially. Default: false.
-
-    options.thisArg: any (optional)
-        Execution context.
-
-    fcn: Function
-        The function to invoke for each element in a collection.
-
-    done: Function
-        A callback invoked either upon processing all collection elements or
-        upon encountering an error.
-
-    Examples
-    --------
-    // Basic usage:
-    > function fcn( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, value*index );
-    ...     }
-    ... };
-    > function done( error, collection ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( collection === arr );
-    ...     console.log( collection );
-    ... };
-    > var arr = [ 1000, 2500, 3000 ];
-    > {{alias}}( arr, fcn, done )
-    1000
-    2500
-    3000
-    true
-    [ 0, 2500, 6000 ]
-
-    // Limit number of concurrent invocations:
-    > function fcn( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, value*index );
-    ...     }
-    ... };
-    > function done( error, collection ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( collection === arr );
-    ...     console.log( collection );
-    ... };
-    > var opts = { 'limit': 2 };
-    > var arr = [ 1000, 2500, 3000 ];
-    > {{alias}}( arr, opts, fcn, done )
-    2500
-    3000
-    1000
-    true
-    [ 0, 2500, 6000 ]
-
-    // Process sequentially:
-    > function fcn( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, value*index );
-    ...     }
-    ... };
-    > function done( error, collection ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( collection === arr );
-    ...     console.log( collection );
-    ... };
-    > var opts = { 'series': true };
-    > var arr = [ 1000, 2500, 3000 ];
-    > {{alias}}( arr, opts, fcn, done )
-    3000
-    2500
-    1000
-    true
-    [ 0, 2500, 6000 ]
-
-
-{{alias}}.factory( [options,] fcn )
-    Returns a function which invokes a function once for each element in a
-    collection and updates a collection in-place, iterating from right to left.
-
-    Parameters
-    ----------
-    options: Object (optional)
-        Function options.
-
-    options.limit: integer (optional)
-        Maximum number of pending invocations. Default: Infinity.
-
-    options.series: boolean (optional)
-        Boolean indicating whether to process each collection element
-        sequentially. Default: false.
-
-    options.thisArg: any (optional)
-        Execution context.
-
-    fcn: Function
-        The function to invoke for each element in a collection.
-
-    Returns
-    -------
-    out: Function
-        A function which invokes a function for each element in a collection.
-
-    Examples
-    --------
-    > function fcn( value, index, next ) {
-    ...     setTimeout( onTimeout, value );
-    ...     function onTimeout() {
-    ...         console.log( value );
-    ...         next( null, value*index );
-    ...     }
-    ... };
-    > var opts = { 'series': true };
-    > var f = {{alias}}.factory( opts, fcn );
-    > function done( error, collection ) {
-    ...     if ( error ) {
-    ...         throw error;
-    ...     }
-    ...     console.log( collection === arr );
-    ...     console.log( collection );
-    ... };
-    > var arr = [ 1000, 2500, 3000 ];
-    > f( arr, done )
-    3000
-    2500
-    1000
-    true
-    [ 0, 2500, 6000 ]
-    > arr = [ 1000, 1500, 2000 ];
-    > f( arr, done )
-    2000
-    1500
-    1000
-    true
-    [ 0, 1500, 4000 ]
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,149 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2021 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-import inmapRightAsync = require( './index' );
-
-const fcn = ( value: number, index: number, next: Function ): void => {
-	next( null, value * index );
-};
-
-const done = ( error: Error | null ) => {
-	if ( error ) {
-		throw error;
-	}
-};
-
-
-// TESTS //
-
-// The function returns void...
-{
-	inmapRightAsync( [ 0, 1, 1 ], fcn, done ); // $ExpectType void
-	inmapRightAsync( [ -1, 1, 2 ], fcn, done ); // $ExpectType void
-}
-
-// The compiler throws an error if the function is provided a first argument which is not a collection...
-{
-	inmapRightAsync( 2, fcn, done ); // $ExpectError
-	inmapRightAsync( false, fcn, done ); // $ExpectError
-	inmapRightAsync( true, fcn, done ); // $ExpectError
-	inmapRightAsync( {}, fcn, done ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is not a function...
-{
-	inmapRightAsync( [ 1, 2, 3 ], 2, done ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], false, done ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], true, done ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], 'abc', done ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], {}, done ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], [], done ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a last argument which is not a function having a supported signature...
-{
-	inmapRightAsync( [ 1, 2, 3 ], fcn, 2 ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], fcn, false ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], fcn, true ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], fcn, 'abc' ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], fcn, {} ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], fcn, [] ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], fcn, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an invalid number of arguments...
-{
-	inmapRightAsync(); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ] ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], fcn ); // $ExpectError
-	inmapRightAsync( [ 1, 2, 3 ], {}, fcn, done, {} ); // $ExpectError
-}
-
-// Attached to main export is a `factory` method which returns a function...
-{
-	inmapRightAsync.factory( fcn ); // $ExpectType FactoryFunction
-	inmapRightAsync.factory( { 'series': true }, fcn ); // $ExpectType FactoryFunction
-}
-
-// The compiler throws an error if the `factory` method is provided an options argument which is not an object...
-{
-	inmapRightAsync.factory( [], fcn ); // $ExpectError
-	inmapRightAsync.factory( 123, fcn ); // $ExpectError
-	inmapRightAsync.factory( 'abc', fcn ); // $ExpectError
-	inmapRightAsync.factory( false, fcn ); // $ExpectError
-	inmapRightAsync.factory( true, fcn ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided a last argument which is not a function...
-{
-	inmapRightAsync.factory( {} ); // $ExpectError
-	inmapRightAsync.factory( true ); // $ExpectError
-	inmapRightAsync.factory( false ); // $ExpectError
-	inmapRightAsync.factory( {}, 123 ); // $ExpectError
-	inmapRightAsync.factory( {}, 'abc' ); // $ExpectError
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments...
-{
-	const fcn1 = inmapRightAsync.factory( fcn );
-	fcn1( 12, done ); // $ExpectError
-	fcn1( true, done ); // $ExpectError
-	fcn1( false, done ); // $ExpectError
-	fcn1( {}, done ); // $ExpectError
-
-	fcn1( [ 1, 2, 3 ], 12 ); // $ExpectError
-	fcn1( [ 1, 2, 3 ], true ); // $ExpectError
-	fcn1( [ 1, 2, 3 ], false ); // $ExpectError
-	fcn1( [ 1, 2, 3 ], '5' ); // $ExpectError
-	fcn1( [ 1, 2, 3 ], {} ); // $ExpectError
-	fcn1( [ 1, 2, 3 ], [] ); // $ExpectError
-	fcn1( [ 1, 2, 3 ], ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments...
-{
-	const fcn1 = inmapRightAsync.factory( fcn );
-	fcn1(); // $ExpectError
-	fcn1( [ 1, 2, 3 ] ); // $ExpectError
-	fcn1( [ 1, 2, 3 ], done, {} ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided a `limit` option which is not a number...
-{
-	inmapRightAsync.factory( { 'limit': '12' }, fcn ); // $ExpectError
-	inmapRightAsync.factory( { 'limit': true }, fcn ); // $ExpectError
-	inmapRightAsync.factory( { 'limit': false }, fcn ); // $ExpectError
-	inmapRightAsync.factory( { 'limit': {} }, fcn ); // $ExpectError
-	inmapRightAsync.factory( { 'limit': [] }, fcn ); // $ExpectError
-	inmapRightAsync.factory( { 'limit': ( x: number ): number => x }, fcn ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided a `series` option which is not a boolean...
-{
-	inmapRightAsync.factory( { 'series': '12' }, fcn ); // $ExpectError
-	inmapRightAsync.factory( { 'series': 12 }, fcn ); // $ExpectError
-	inmapRightAsync.factory( { 'series': {} }, fcn ); // $ExpectError
-	inmapRightAsync.factory( { 'series': [] }, fcn ); // $ExpectError
-	inmapRightAsync.factory( { 'series': ( x: number ): number => x }, fcn ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided an invalid number of arguments...
-{
-	inmapRightAsync.factory(); // $ExpectError
-	inmapRightAsync.factory( {}, fcn, {} ); // $ExpectError
-}