@futagoza/core-js/math.clamp.js

Ponyfill's for some native ES2017+ built-in methods

"use strict";

const ExpectingNumberArgument = require( "./lib/ExpectingNumberArgument" );

const P = require( "./lib/ImportablePath" )( "math.clamp( value, lower, upper )" );

/**
 * Clamp a number.
 * 
 * @specification esnext (stage 1)
 * @since 1.0.0-alpha.0
 * @param {Number} value The current number
 * @param {Number} lower The minimum number
 * @param {Number} upper The maximum number
 * @returns {Number} The clamed value.
 */
function clamp( value, lower, upper ) {

    ExpectingNumberArgument( value, P, "value" );
    ExpectingNumberArgument( lower, P, "lower" );
    ExpectingNumberArgument( upper, P, "upper" );

    if ( Number.isNaN( value ) ) return NaN;
    if ( Number.isNaN( lower ) ) return NaN;
    if ( Number.isNaN( upper ) ) return NaN;

    return Math.min( upper, Math.max( lower, value ) );

}

module.exports = clamp;