validate.js (1796B)
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 isPositiveNumber = require( '@stdlib/assert/is-positive-number' ).isPrimitive; 24 var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive; 25 var isnan = require( '@stdlib/assert/is-nan' ); 26 27 28 // MAIN // 29 30 /** 31 * Validates parameters. 32 * 33 * @private 34 * @param {PositiveNumber} alpha - shape parameter 35 * @param {PositiveNumber} s - scale parameter 36 * @param {number} m - location parameter 37 * @returns {(Error|null)} error or null 38 * 39 * @example 40 * var err = validate( 1.0, 2.0, 1.3 ); 41 * if ( err ) { 42 * throw err; 43 * } 44 */ 45 function validate( alpha, s, m ) { 46 if ( !isPositiveNumber( alpha ) || isnan( alpha ) ) { 47 return new TypeError( 'invalid argument. First argument must be a positive number primitive and not `NaN`. Value: `'+alpha+'`.' ); 48 } 49 if ( !isPositiveNumber( s ) || isnan( s ) ) { 50 return new TypeError( 'invalid argument. Second argument must be a positive number primitive and not `NaN`. Value: `'+s+'`.' ); 51 } 52 if ( !isNumber( m ) || isnan( m ) ) { 53 return new TypeError( 'invalid argument. Third argument must be a number primitive and not `NaN`. Value: `'+m+'`.' ); 54 } 55 return null; 56 } 57 58 59 // EXPORTS // 60 61 module.exports = validate;