time-to-botec

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

do_while.js (1724B)

      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 // MODULES //
     22 
     23 var isFunction = require( '@stdlib/assert/is-function' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Invokes a function while a test condition is true.
     30 *
     31 * @param {Function} fcn - function to invoke
     32 * @param {Function} predicate - function which indicates whether to continue invoking a function
     33 * @param {*} [thisArg] - execution context for the invoked function
     34 * @throws {TypeError} first argument must be a function
     35 * @throws {TypeError} second argument must be a function
     36 *
     37 * @example
     38 * function predicate( i ) {
     39 *     return ( i < 5 );
     40 * }
     41 *
     42 * function beep( i ) {
     43 *     console.log( 'beep: %d', i );
     44 * }
     45 *
     46 * doWhile( beep, predicate );
     47 */
     48 function doWhile( fcn, predicate, thisArg ) {
     49 	var i;
     50 	if ( !isFunction( fcn ) ) {
     51 		throw new TypeError( 'invalid argument. First argument must be a function. Value: `'+fcn+'`.' );
     52 	}
     53 	if ( !isFunction( predicate ) ) {
     54 		throw new TypeError( 'invalid argument. Second argument must be a function. Value: `'+predicate+'`.' );
     55 	}
     56 	i = 0;
     57 	do {
     58 		fcn.call( thisArg, i );
     59 		i += 1;
     60 	} while ( predicate( i ) );
     61 }
     62 
     63 
     64 // EXPORTS //
     65 
     66 module.exports = doWhile;