Newman's Personal Motorcade

    @stdlib/utils-do-until
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    doUntil

    NPM version Build Status Coverage Status dependencies

    Invoke a function until a test condition is true.

    Installation

    npm install @stdlib/utils-do-until

    Usage

    var doUntil = require( '@stdlib/utils-do-until' );

    doUntil( fcn, predicate[, thisArg ] )

    Invokes a function until a predicate function returns true. 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 );
    }
    
    doUntil( 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
    };
    
    doUntil( count, predicate, context );
    
    console.log( context.count );
    // => 5

    Examples

    var randu = require( '@stdlib/random-base-randu' );
    var doUntil = require( '@stdlib/utils-do-until' );
    
    function predicate() {
        return ( randu() <= 0.05 );
    }
    
    function log( i ) {
        console.log( i );
    }
    
    doUntil( log, predicate );

    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-2021. The Stdlib Authors.

    Install

    npm i @stdlib/utils-do-until

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    6

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    38.3 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser