time-to-botec/squiggle/node_modules/@stdlib/utils/while/lib/index.js

48 lines
1.0 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
/**
* Invoke a function while a test condition is true.
*
* @module @stdlib/utils/while
*
* @example
* var whilst = require( '@stdlib/utils/while' );
*
* function predicate( i ) {
* return ( i < 5 );
* }
*
* function beep( i ) {
* console.log( 'boop: %d', i );
* }
*
* whilst( predicate, beep );
*/
// MODULES //
var whilst = require( './while.js' );
// EXPORTS //
module.exports = whilst;