utils-do-while-each

While a test condition is true, invoke a function for each element in a collection.

https://github.com/stdlib-js/utils-do-while-each

Science Score: 44.0%

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

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary

Keywords

array array-like collection do do-while dowhile each for foreach iterate javascript node node-js nodejs stdlib util utilities utility utils while

Last synced: 4 months ago · JSON representation ·

Repository

While a test condition is true, invoke a function for each element in a collection.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 965 KB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

array array-like collection do do-while dowhile each for foreach iterate javascript node node-js nodejs stdlib util utilities utility utils while

Created over 4 years ago · Last pushed 8 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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!

doWhileEach

While a test condition is true, invoke a function for each element in a collection.

## Installation ```bash npm install @stdlib/utils-do-while-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 doWhileEach = require( '@stdlib/utils-do-while-each' ); ``` #### doWhileEach( collection, fcn, predicate\[, thisArg ] ) Invokes a `function` for each element in a `collection` until either a `predicate` function returns `false` or the function has iterated over all `collection` elements. Note that the condition is evaluated **after** executing `fcn`; thus, `fcn` **always** executes at least once. ```javascript function predicate( value ) { return ( value === value ); } function log( value, index ) { console.log( '%s: %d', index, value ); } var arr = [ 1, 2, 3, NaN, 4 ]; doWhileEach( arr, log, predicate ); /* => 0: 1 1: 2 2: 3 3: NaN */ ``` Both the `predicate` function and the `function` to apply are provided three arguments: - **value**: collection element. - **index**: collection index. - **collection**: input collection. If provided an empty `collection`, both `value` and `index` are `undefined`. ```javascript function predicate( value ) { return ( value === value ); } function log( value, index ) { console.log( '%s: %s', index, value ); } var arr = []; doWhileEach( arr, log, predicate ); /* => undefined: undefined */ ``` Basic support for dynamic collections is provided. Note, however, that index incrementation is monotonically increasing. ```javascript function predicate( value ) { return ( value === value ); } function log1( value, index, collection ) { console.log( '%s: %d', index, value ); if ( index === collection.length-1 && collection.length < 10 ) { collection.push( index+2 ); } } var arr = [ 1, 2, 3, 4 ]; doWhileEach( arr, log1, predicate ); /* => 0: 1 1: 2 2: 3 3: 4 4: 5 5: 6 6: 7 7: 8 8: 9 9: 10 */ function log2( value, index, collection ) { console.log( '%s: %d', index, value ); collection.shift(); } arr = [ 1, 2, 3, 4 ]; doWhileEach( arr, log2, predicate ); /* => 0: 1 1: 3 */ ``` To set the function execution context for the applied function, provide a `thisArg`. ```javascript function predicate( value ) { return ( value < 3 ); } function sum( value ) { this.sum += value; this.count += 1; } var arr = [ 1, 2, 3, NaN, 4 ]; var context = { 'sum': 0, 'count': 0 }; doWhileEach( arr, sum, predicate, context ); var mean = context.sum / context.count; // returns 2.0 ```

## Notes - A `collection` may be either an [`Array`][mdn-array], [`Typed Array`][mdn-typed-array], or an array-like [`Object`][mdn-object] (excluding `strings` and `functions`). - The function returns the input `collection`. - The function does **not** skip `undefined` elements. ```javascript function predicate( value ) { return ( value === value ); } function log( value, index ) { console.log( '%s: %s', index, value ); } var arr = [ 1, , , 4 ]; doWhileEach( arr, log, predicate ); /* => 0: 1 1: undefined 2: undefined 3: 4 */ ``` - The function provides limited support for dynamic collections (i.e., collections whose `length` changes during execution).

## Examples ```javascript var isEven = require( '@stdlib/assert-is-even' ).isPrimitive; var randu = require( '@stdlib/random-base-randu' ); var floor = require( '@stdlib/math-base-special-floor' ); var doWhileEach = require( '@stdlib/utils-do-while-each' ); function predicate( value ) { return ( value === value ); } function log( value, index, collection ) { console.log( '%s: %d', index, value ); if ( isEven( index ) ) { collection.shift(); } else { collection.push( index+1 ); } } var arr; var j; var i; arr = new Array( 100 ); j = floor( randu()*arr.length ); for ( i = 0; i < arr.length; i++ ) { if ( i === j ) { arr[ i ] = NaN; } else { arr[ i ] = i; } } doWhileEach( arr, log, predicate ); ```

* * * ## 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

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

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

GitHub Events

Total

Push event: 27

Last Year

Push event: 27

Committers

Last synced: almost 2 years ago

All Time

Total Commits: 52
Total Committers: 1
Avg Commits per committer: 52.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 15
Committers: 1
Avg Commits per committer: 15.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	52

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 5 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies

package.json npm

@stdlib/array-float32 ^0.0.x development
@stdlib/array-float64 ^0.0.x development
@stdlib/assert-is-even ^0.0.x development
@stdlib/assert-is-nan ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/constants-float64-pinf ^0.0.x development
@stdlib/math-base-assert-is-nan ^0.0.x development
@stdlib/math-base-special-floor ^0.0.x development
@stdlib/random-base-randu ^0.0.x development
@stdlib/utils-noop ^0.0.x development
istanbul ^0.4.1 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-is-collection ^0.0.x
@stdlib/assert-is-function ^0.0.x
@stdlib/string-format ^0.0.x
@stdlib/types ^0.0.x

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

utils-do-while-each

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

doWhileEach

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies