Invoke a function while a test condition is true.
npm install @stdlib/utils-do-whileAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var doWhile = require( '@stdlib/utils-do-while' );Invokes a function until a predicate function returns false. Note that the predicate function is evaluated after executing fcn; thus, fcn always executes at least once.
function predicate( i ) {
return ( i < 5 );
}
function beep( i ) {
console.log( 'boop: %d', i );
}
doWhile( beep, predicate );
/* =>
boop: 0
boop: 1
boop: 2
boop: 3
boop: 4
*/Both the predicate function and the function to invoke are provided a single argument:
i: iteration number (starting from zero)
To set the function execution context for the invoked function, provide a thisArg.
function predicate( i ) {
return ( i < 5 );
}
function count() {
this.count += 1;
}
var context = {
'count': 0
};
doWhile( count, predicate, context );
console.log( context.count );
// => 5var randu = require( '@stdlib/random-base-randu' );
var doWhile = require( '@stdlib/utils-do-while' );
function predicate() {
return ( randu() > 0.05 );
}
function log( i ) {
console.log( i );
}
doWhile( log, predicate );@stdlib/utils/do-until: invoke a function until a test condition is true.@stdlib/utils/async/do-while: invoke a function while a test condition is true.@stdlib/utils/do-while-each: while a test condition is true, invoke a function for each element in a collection.@stdlib/utils/until: invoke a function until a test condition is true.@stdlib/utils/while: invoke a function while a test condition is true.
This package is part of 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, see the main project repository.
See LICENSE.
Copyright © 2016-2023. The Stdlib Authors.
