time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1284B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 /**
     22 * Invoke a function while a test condition is true.
     23 *
     24 * @module @stdlib/utils/async/do-while
     25 *
     26 * @example
     27 * var doWhileAsync = require( '@stdlib/utils/async/do-while' );
     28 *
     29 * function fcn( i, next ) {
     30 *     setTimeout( onTimeout, i );
     31 *     function onTimeout() {
     32 *         console.log( 'beep: %d', i );
     33 *         next();
     34 *     }
     35 * }
     36 *
     37 * function predicate( i, clbk ) {
     38 *     clbk( null, i < 5 );
     39 * }
     40 *
     41 * function done( error ) {
     42 *     if ( error ) {
     43 *         throw error;
     44 *     }
     45 * }
     46 *
     47 * doWhileAsync( fcn, predicate, done );
     48 */
     49 
     50 // MODULES //
     51 
     52 var doWhileAsync = require( './do_while_async.js' );
     53 
     54 
     55 // EXPORTS //
     56 
     57 module.exports = doWhileAsync;