@stdlib/utils-while-each 0.0.4 → 0.0.8

package/NOTICE

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

package/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # 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 +250,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 +291,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -295,9 +310,20 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [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
 
+-->
+
+[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
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
 [chat-url]: https://gitter.im/stdlib-js/stdlib/
 
@@ -313,6 +339,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/docs/types/index.d.ts

@@ -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 = ( value: any, index: number, collection: Collection ) => boolean; // tslint-disable-line max-line-length
 
 /**
 * Checks whether an element in a collection passes a test.
@@ -64,7 +64,7 @@ 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 = NullaryPredicate | UnaryPredicate | BinaryPredicate | TernaryPredicate; // tslint-disable-line max-line-length
 
 /**
 * 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 = ( value: any, index: number, collection: Collection ) => 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 = Nullary | Unary | Binary | Ternary;
 
 /**
 * While a test condition is true, invokes a function once for each element in a collection.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/utils-while-each",
-  "version": "0.0.4",
+  "version": "0.0.8",
   "description": "While a test condition is true, invoke a function for each element in a collection.",
   "license": "Apache-2.0",
   "author": {

package/CHANGELOG.md

@@ -1,5 +0,0 @@
-# CHANGELOG
-
-> Package changelog.
-
-See [GitHub Releases](https://github.com/stdlib-js/utils-while-each/releases) for the changelog.