@stdlib/utils-while-each 0.0.7 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

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-2021 The Stdlib Authors.
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -18,9 +18,20 @@ 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>
+
 # whileEach
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
 > While a test condition is true, invoke a function for each element in a collection.
 
@@ -250,6 +261,21 @@ whileEach( arr, predicate, log );
 
 <!-- /.references -->
 
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/utils-until-each`][@stdlib/utils/until-each]</span><span class="delimiter">: </span><span class="description">until a test condition is true, invoke a function for each element in a collection.</span>
+-   <span class="package-name">[`@stdlib/utils-while-each-right`][@stdlib/utils/while-each-right]</span><span class="delimiter">: </span><span class="description">while a test condition is true, invoke a function for each element in a collection, iterating from right to left.</span>
+
+</section>
+
+<!-- /.related -->
+
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 
@@ -276,7 +302,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -289,22 +315,34 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/utils-while-each.svg
 [npm-url]: https://npmjs.org/package/@stdlib/utils-while-each
 
-[test-image]: https://github.com/stdlib-js/utils-while-each/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/utils-while-each/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/utils-while-each/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/utils-while-each/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-while-each/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/utils-while-each?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/utils-while-each.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/utils-while-each/main
 
+-->
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[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-while-each/tree/deno
+[umd-url]: https://github.com/stdlib-js/utils-while-each/tree/umd
+[esm-url]: https://github.com/stdlib-js/utils-while-each/tree/esm
+[branches-url]: https://github.com/stdlib-js/utils-while-each/blob/main/branches.md
+
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-while-each/main/LICENSE
 
 [mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
@@ -313,6 +351,14 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 
 [mdn-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
 
+<!-- <related-links> -->
+
+[@stdlib/utils/until-each]: https://www.npmjs.com/package/@stdlib/utils-until-each
+
+[@stdlib/utils/while-each-right]: https://www.npmjs.com/package/@stdlib/utils-while-each-right
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var v=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var m=v(function(E,s){
+var g=require('@stdlib/assert-is-collection/dist'),n=require('@stdlib/assert-is-function/dist'),t=require('@stdlib/error-tools-fmtprodmsg/dist');function w(r,e,u,h){var i,a;if(!g(r))throw new TypeError(t('1YRAh',r));if(!n(e))throw new TypeError(t('1YR2H',e));if(!n(u))throw new TypeError(t('1YR3N',u));for(i=r.length,a=0;a<i&&e(r[a],a,r);)u.call(h,r[a],a,r),a+=1,i=r.length;return r}s.exports=w
+});var f=m();module.exports=f;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../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 isCollection = require( '@stdlib/assert-is-collection' );\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* While a test condition is true, invokes a function once for each element in a collection.\n*\n* @param {Collection} collection - input collection\n* @param {Function} predicate - function which indicates whether to continue iterating over a collection\n* @param {Function} fcn - function to invoke\n* @param {*} [thisArg] - execution context for the applied function\n* @throws {TypeError} first argument must be a collection\n* @throws {TypeError} second argument must be a function\n* @throws {TypeError} third argument must be a function\n* @returns {Collection} input collection\n*\n* @example\n* function predicate( v, index, collection ) {\n*     return ( v === v );\n* }\n*\n* function log( v, index, collection ) {\n*     console.log( '%s: %d', index, v );\n* }\n*\n* var arr = [ 1, 2, 3, 4, NaN, 5 ];\n*\n* whileEach( arr, predicate, log );\n*/\nfunction whileEach( collection, predicate, fcn, thisArg ) {\n\tvar len;\n\tvar i;\n\tif ( !isCollection( collection ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a collection. Value: `%s`.', collection ) );\n\t}\n\tif ( !isFunction( predicate ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', predicate ) );\n\t}\n\tif ( !isFunction( fcn ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a function. Value: `%s`.', fcn ) );\n\t}\n\tlen = collection.length;\n\ti = 0;\n\twhile (\n\t\ti < len &&\n\t\tpredicate( collection[ i ], i, collection )\n\t) {\n\t\tfcn.call( thisArg, collection[ i ], i, collection );\n\t\ti += 1;\n\t\tlen = collection.length; // ...account for dynamically resizing a collection\n\t}\n\treturn collection;\n}\n\n\n// EXPORTS //\n\nmodule.exports = whileEach;\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* While a test condition is true, invoke a function once for each element in a collection.\n*\n* @module @stdlib/utils-while-each\n*\n* @example\n* var whileEach = require( '@stdlib/utils-while-each' );\n*\n* function predicate( v, index, collection ) {\n*     return ( v === v );\n* }\n*\n* function log( v, index, collection ) {\n*     console.log( '%s: %d', index, v );\n* }\n*\n* var arr = [ 1, 2, 3, 4, NaN, 5 ];\n*\n* whileEach( arr, predicate, log );\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAa,QAAS,4BAA6B,EACnDC,EAAS,QAAS,uBAAwB,EA8B9C,SAASC,EAAWC,EAAYC,EAAWC,EAAKC,EAAU,CACzD,IAAIC,EACAC,EACJ,GAAK,CAACT,EAAcI,CAAW,EAC9B,MAAM,IAAI,UAAWF,EAAQ,sEAAuEE,CAAW,CAAE,EAElH,GAAK,CAACH,EAAYI,CAAU,EAC3B,MAAM,IAAI,UAAWH,EAAQ,qEAAsEG,CAAU,CAAE,EAEhH,GAAK,CAACJ,EAAYK,CAAI,EACrB,MAAM,IAAI,UAAWJ,EAAQ,oEAAqEI,CAAI,CAAE,EAIzG,IAFAE,EAAMJ,EAAW,OACjBK,EAAI,EAEHA,EAAID,GACJH,EAAWD,EAAYK,CAAE,EAAGA,EAAGL,CAAW,GAE1CE,EAAI,KAAMC,EAASH,EAAYK,CAAE,EAAGA,EAAGL,CAAW,EAClDK,GAAK,EACLD,EAAMJ,EAAW,OAElB,OAAOA,CACR,CAKAL,EAAO,QAAUI,ICvCjB,IAAIO,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "isFunction", "format", "whileEach", "collection", "predicate", "fcn", "thisArg", "len", "i", "main"]
+}

package/docs/types/index.d.ts

@@ -16,11 +16,11 @@
 * 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';
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -35,7 +35,7 @@ type NullaryPredicate = () => boolean;
 * @param value - collection value
 * @returns boolean indicating whether an element in a collection passes a test
 */
-type UnaryPredicate = ( value: any ) => boolean;
+type UnaryPredicate<T> = ( value: T ) => boolean;
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -44,7 +44,7 @@ type UnaryPredicate = ( value: any ) => boolean;
 * @param index - collection index
 * @returns boolean indicating whether an element in a collection passes a test
 */
-type BinaryPredicate = ( value: any, index: number ) => boolean;
+type BinaryPredicate<T> = ( value: T, index: number ) => boolean;
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -54,7 +54,7 @@ type BinaryPredicate = ( value: any, index: number ) => boolean;
 * @param collection - input collection
 * @returns boolean indicating whether an element in a collection passes a test
 */
-type TertiaryPredicate = ( value: any, index: number, collection: Collection ) => boolean; // tslint-disable-line max-line-length
+type TernaryPredicate<T> = ( value: T, index: number, collection: Collection<T> ) => boolean;
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -64,19 +64,19 @@ type TertiaryPredicate = ( value: any, index: number, collection: Collection ) =
 * @param collection - input collection
 * @returns boolean indicating whether an element in a collection passes a test
 */
-type Predicate = NullaryPredicate | UnaryPredicate | BinaryPredicate | TertiaryPredicate; // tslint-disable-line max-line-length
+type Predicate<T> = NullaryPredicate | UnaryPredicate<T> | BinaryPredicate<T> | TernaryPredicate<T>;
 
 /**
 * Function invoked for each collection element passing a test.
 */
-type Nullary = () => void;
+type Nullary<U> = ( this: U ) => void;
 
 /**
 * Function invoked for each collection element passing a test.
 *
 * @param value - collection value
 */
-type Unary = ( value: any ) => void;
+type Unary<T, U> = ( this: U, value: T ) => void;
 
 /**
 * Function invoked for each collection element passing a test.
@@ -84,7 +84,7 @@ type Unary = ( value: any ) => void;
 * @param value - collection value
 * @param index - collection index
 */
-type Binary = ( value: any, index: number ) => void;
+type Binary<T, U> = ( this: U, value: T, index: number ) => void;
 
 /**
 * Function invoked for each collection element passing a test.
@@ -93,7 +93,7 @@ type Binary = ( value: any, index: number ) => void;
 * @param index - collection index
 * @param collection - input collection
 */
-type Tertiary = ( value: any, index: number, collection: Collection ) => void;
+type Ternary<T, U> = ( this: U, value: T, index: number, collection: Collection<T> ) => void;
 
 /**
 * Function invoked for each collection element passing a test.
@@ -102,7 +102,7 @@ type Tertiary = ( value: any, index: number, collection: Collection ) => void;
 * @param index - collection index
 * @param collection - input collection
 */
-type Callback = Nullary | Unary | Binary | Tertiary;
+type Callback<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
 
 /**
 * While a test condition is true, invokes a function once for each element in a collection.
@@ -134,7 +134,7 @@ type Callback = Nullary | Unary | Binary | Tertiary;
 *
 * whileEach( arr, predicate, log );
 */
-declare function whileEach( collection: Collection, predicate: Predicate, fcn: Callback, thisArg?: any ): Collection; // tslint-disable-line max-line-length
+declare function whileEach<T = unknown, U = unknown>( collection: Collection<T>, predicate: Predicate<T>, fcn: Callback<T, U>, thisArg?: ThisParameterType<Callback<T, U>> ): Collection<T>;
 
 
 // EXPORTS //

package/lib/index.js

@@ -41,9 +41,9 @@
 
 // MODULES //
 
-var whileEach = require( './while_each.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = whileEach;
+module.exports = main;

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

@@ -22,6 +22,7 @@
 
 var isCollection = require( '@stdlib/assert-is-collection' );
 var isFunction = require( '@stdlib/assert-is-function' );
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -55,13 +56,13 @@ function whileEach( collection, predicate, fcn, thisArg ) {
 	var len;
 	var i;
 	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( predicate ) ) {
-		throw new TypeError( 'invalid argument. Second argument must be a function. Value: `'+predicate+'`.' );
+		throw new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', predicate ) );
 	}
 	if ( !isFunction( fcn ) ) {
-		throw new TypeError( 'invalid argument. Third argument must be a function. Value: `'+fcn+'`.' );
+		throw new TypeError( format( 'invalid argument. Third argument must be a function. Value: `%s`.', fcn ) );
 	}
 	len = collection.length;
 	i = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-while-each",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "While a test condition is true, invoke a function for each element in a collection.",
   "license": "Apache-2.0",
   "author": {
@@ -37,22 +37,24 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-is-collection": "^0.0.x",
-    "@stdlib/assert-is-function": "^0.0.x",
-    "@stdlib/types": "^0.0.x"
+    "@stdlib/assert-is-collection": "^0.1.0",
+    "@stdlib/assert-is-function": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/types": "^0.1.0",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-float32": "^0.0.x",
-    "@stdlib/array-float64": "^0.0.x",
-    "@stdlib/assert-is-even": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-special-floor": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
-    "@stdlib/utils-noop": "^0.0.x",
+    "@stdlib/array-float32": "^0.1.0",
+    "@stdlib/array-float64": "^0.1.0",
+    "@stdlib/assert-is-even": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-special-floor": "^0.1.0",
+    "@stdlib/random-base-randu": "^0.0.8",
+    "@stdlib/utils-noop": "^0.1.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"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -89,7 +91,7 @@
     "typed array"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,47 +0,0 @@
-
-{{alias}}( collection, predicate, fcn[, thisArg] )
-    While a test condition is true, invokes a function for each element in a
-    collection.
-
-    When invoked, both the predicate function and the function to apply are
-    provided three arguments:
-
-    - `value`: collection value
-    - `index`: collection index
-    - `collection`: the input collection
-
-    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).
-
-    predicate: Function
-        The predicate function which indicates whether to continue iterating
-        over a collection.
-
-    fcn: Function
-        The function to invoke for each element in a collection.
-
-    thisArg: any (optional)
-        Execution context for the applied function.
-
-    Returns
-    -------
-    out: Array|TypedArray|Object
-        Input collection.
-
-    Examples
-    --------
-    > function predicate( v ) { return v === v; };
-    > function logger( v, i ) { console.log( '%s: %d', i, v ); };
-    > var arr = [ 1, 2, 3, 4, NaN, 5 ];
-    > {{alias}}( arr, predicate, logger )
-    0: 1
-    1: 2
-    2: 3
-    3: 4
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,71 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2019 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 whileEach = require( './index' );
-
-const log = ( v: any, index: number ): void => {
-	console.log( `${index}: ${v}` );
-};
-
-const isNotNaN = ( v: number ): boolean => {
-	return ( v === v );
-};
-
-// TESTS //
-
-// The function returns the input collection...
-{
-	whileEach( [ 0, 1, 1, NaN, 2 ], isNotNaN, log ); // $ExpectType Collection
-	whileEach( [ -1, 1, 2 ], isNotNaN, log, {} ); // $ExpectType Collection
-}
-
-// The compiler throws an error if the function is provided a first argument which is not a collection...
-{
-	whileEach( 2, isNotNaN, log ); // $ExpectError
-	whileEach( false, isNotNaN, log ); // $ExpectError
-	whileEach( true, isNotNaN, log ); // $ExpectError
-	whileEach( {}, isNotNaN, log ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is not a function...
-{
-	whileEach( [ 0, 1, 1, NaN, 2 ], 2, log ); // $ExpectError
-	whileEach( [ 0, 1, 1, NaN, 2 ], false, log ); // $ExpectError
-	whileEach( [ 0, 1, 1, NaN, 2 ], true, log ); // $ExpectError
-	whileEach( [ 0, 1, 1, NaN, 2 ], 'abc', log ); // $ExpectError
-	whileEach( [ 0, 1, 1, NaN, 2 ], {}, log ); // $ExpectError
-	whileEach( [ 0, 1, 1, NaN, 2 ], [], log ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a third argument which is not a function...
-{
-	whileEach( [ 0, 1, 1, NaN, 2 ], isNotNaN, 2 ); // $ExpectError
-	whileEach( [ 0, 1, 1, NaN, 2 ], isNotNaN, false ); // $ExpectError
-	whileEach( [ 0, 1, 1, NaN, 2 ], isNotNaN, true ); // $ExpectError
-	whileEach( [ 0, 1, 1, NaN, 2 ], isNotNaN, 'abc' ); // $ExpectError
-	whileEach( [ 0, 1, 1, NaN, 2 ], isNotNaN, {} ); // $ExpectError
-	whileEach( [ 0, 1, 1, NaN, 2 ], isNotNaN, [] ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an invalid number of arguments...
-{
-	whileEach(); // $ExpectError
-	whileEach( [ 1, 2, 3 ] ); // $ExpectError
-	whileEach( [ 1, 2, 3 ], isNotNaN ); // $ExpectError
-	whileEach( [ 1, 2, 3 ], isNotNaN, log, {}, 3 ); // $ExpectError
-}