time-to-botec

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

validate.js (1619B)


      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 isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
     24 var isnan = require( '@stdlib/assert/is-nan' );
     25 
     26 
     27 // MAIN //
     28 
     29 /**
     30 * Validates values provided for minimum and maximum support.
     31 *
     32 * @private
     33 * @param {number} a - minimum support
     34 * @param {number} b - maximum support
     35 * @returns {(Error|null)} error or null
     36 *
     37 * @example
     38 * var err = validate( 1.0, 2.0 );
     39 * if ( err ) {
     40 *     throw err;
     41 * }
     42 */
     43 function validate( a, b ) {
     44 	if ( !isNumber( a ) || isnan( a ) ) {
     45 		return new TypeError( 'invalid argument. First argument must be a number primitive and not `NaN`. Value: `'+a+'`.' );
     46 	}
     47 	if ( !isNumber( b ) || isnan( b ) ) {
     48 		return new TypeError( 'invalid argument. Second argument must be a number primitive and not `NaN`. Value: `'+b+'`.' );
     49 	}
     50 	if ( a >= b ) {
     51 		return new RangeError( 'invalid argument. Minimum support `a` must be less than maximum support `b`. Value: `['+a+','+b+']`.');
     52 	}
     53 	return null;
     54 }
     55 
     56 
     57 // EXPORTS //
     58 
     59 module.exports = validate;