Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/iter-do-until-each

Create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value.

https://github.com/stdlib-js/iter-do-until-each

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary

Keywords

do-until-each dountileach each iterable iterate iterator javascript node node-js nodejs stdlib until util utilities utility utils
Last synced: 6 months ago · JSON representation

Repository

Create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
do-until-each dountileach each iterable iterate iterator javascript node node-js nodejs stdlib until util utilities utility utils
Created almost 2 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

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.

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.

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.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

iterDoUntilEach

NPM version Build Status Coverage Status <!-- dependencies -->

Create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value.

## Installation ```bash npm install @stdlib/iter-do-until-each ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage ```javascript var iterDoUntilEach = require( '@stdlib/iter-do-until-each' ); ``` #### iterDoUntilEach( iterator, predicate, fcn\[, thisArg] ) Returns an iterator which invokes a function for each iterated value **before** returning the iterated value until either a `predicate` function returns `true` or the iterator has iterated over all values. Note that the condition is evaluated **after** executing `fcn`; thus, `fcn` **always** executes at least once. ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); function predicate( v ) { return v > 2; } function assert( v ) { if ( v !== v ) { throw new Error( 'should not be NaN' ); } } var it = iterDoUntilEach( array2iterator( [ 1, 2, 3, 4 ] ), predicate, assert ); // returns {} var r = it.next().value; // returns 1 r = it.next().value; // returns 2 r = it.next().value; // undefined // ... ``` The returned iterator protocol-compliant object has the following properties: - **next**: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a boolean value indicating whether the iterator is finished. - **return**: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object. Both the `predicate` function and the function to invoke for each iterated value are provided two arguments: - **value**: iterated value. - **index**: iteration index (zero-based). ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); function predicate( v ) { return v > 2; } function assert( v, i ) { if ( i > 2 ) { throw new Error( 'unexpected error' ); } } var it = iterDoUntilEach( array2iterator( [ 1, 2, 3, 4 ] ), predicate, assert ); // returns var r = it.next().value; // returns 1 r = it.next().value; // returns 2 r = it.next().value; // undefined // ... ``` To set the execution context for `fcn`, provide a `thisArg`. ```javascript var array2iterator = require( '@stdlib/array-to-iterator' ); function assert( v ) { this.count += 1; if ( v !== v ) { throw new Error( 'should not be NaN' ); } } function predicate( v ) { return v > 2; } var c = { 'count': 0 }; var it = iterDoUntilEach( array2iterator( [ 1, 2, 3 ] ), predicate, assert, c ); // returns var r = it.next().value; // returns 1 r = it.next().value; // returns 2 r = it.next().value; // returns undefined var count = c.count; // returns 3 ```
## Notes - If an environment supports `Symbol.iterator` **and** a provided iterator is iterable, the returned iterator is iterable.
## Examples ```javascript var randu = require( '@stdlib/random-iter-randu' ); var isnan = require( '@stdlib/math-base-assert-is-nan' ); var iterDoUntilEach = require( '@stdlib/iter-do-until-each' ); function assert( v ) { if ( isnan( v ) ) { throw new Error( 'should not be NaN' ); } } function predicate( v ) { return v <= 0.75; } // Create a seeded iterator for generating pseudorandom numbers: var rand = randu({ 'seed': 1234, 'iter': 10 }); // Create an iterator which validates generated numbers: var it = iterDoUntilEach( rand, predicate, assert ); // Perform manual iteration... var r; while ( true ) { r = it.next(); if ( r.done ) { break; } console.log( r.value ); } ```
* * * ## See Also - [`@stdlib/iter-do-while-each`][@stdlib/iter/do-while-each]: create an iterator which, while a test condition is true, invokes a function for each iterated value before returning the iterated value. - [`@stdlib/iter-until-each`][@stdlib/iter/until-each]: create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value. - [`@stdlib/iter-while-each`][@stdlib/iter/while-each]: create an iterator which, while a test condition is true, invokes a function for each iterated value before returning the iterated value.
* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

GitHub Events

Total
  • Push event: 33
Last Year
  • Push event: 33

Packages

  • Total packages: 1
  • Total downloads:
    • npm 3 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 4
npmjs.org: @stdlib/iter-do-until-each

Create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.1.1
    published over 1 year ago
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 3 Last month
Rankings
Dependent repos count: 30.7%
Average: 37.3%
Dependent packages count: 43.9%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 6 months ago

Dependencies

.github/workflows/benchmark.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite
.github/workflows/examples.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/productionize.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish 4b07b26a2f6e0a51846e1870223e545bae91c552 composite
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/test.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • codecov/codecov-action eaaf4bedf32dbdc6b720b63067d99c4d77d6047d composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/test_install.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
package.json npm
  • @stdlib/array-to-iterator ^0.2.1 development
  • @stdlib/bench-harness ^0.2.1 development
  • @stdlib/math-base-assert-is-nan ^0.2.1 development
  • @stdlib/random-iter-randu ^0.2.1 development
  • @stdlib/utils-noop ^0.2.1 development
  • istanbul ^0.4.1 development
  • proxyquire ^2.0.0 development
  • tap-min git+https://github.com/Planeshifter/tap-min.git development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/assert-is-function ^0.2.1
  • @stdlib/assert-is-iterator-like ^0.2.1
  • @stdlib/error-tools-fmtprodmsg ^0.2.1
  • @stdlib/string-format ^0.2.1
  • @stdlib/symbol-iterator ^0.2.1
  • @stdlib/types ^0.3.2
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.2.1