Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Invoke a function while a test condition is true.

License

Notifications You must be signed in to change notification settings

stdlib-js/utils-while

 
 

Repository files navigation

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!

while

NPM version Build Status Coverage Status

Invoke a function while a test condition is true.

Usage

To use in Observable,

whilst = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-while@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var whilst = require( 'path/to/vendor/umd/utils-while/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/utils-while@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.whilst;
})();
</script>

whilst( predicate, fcn[, thisArg ] )

Invokes a function until a predicate function returns false.

function predicate( i ) {
    return ( i < 5 );
}

function beep( i ) {
    console.log( 'boop: %d', i );
}

whilst( predicate, beep );
/* =>
    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
};

whilst( predicate, count, context );

console.log( context.count );
// => 5

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-randu@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/utils-while@umd/browser.js"></script>
<script type="text/javascript">
(function () {

function predicate() {
    return ( randu() > 0.05 );
}

function log( i ) {
    console.log( i );
}

whilst( predicate, log );

})();
</script>
</body>
</html>

See Also


Notice

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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.