validate.js (1911B)
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 hasOwnProp = require( '@stdlib/assert/has-own-property' ); 24 var isObject = require( '@stdlib/assert/is-plain-object' ); 25 var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive; 26 var isnan = require( '@stdlib/assert/is-nan' ); 27 28 29 // MAIN // 30 31 /** 32 * Validates function options. 33 * 34 * @private 35 * @param {Object} opts - destination object 36 * @param {Options} options - function options 37 * @param {number} [options.alpha] - significance level 38 * @returns {(Error|null)} null or an error object 39 * 40 * @example 41 * var opts = {}; 42 * var options = { 43 * 'alpha': 0.6 44 * }; 45 * var err = validate( opts, options ); 46 * if ( err ) { 47 * throw err; 48 * } 49 */ 50 function validate( opts, options ) { 51 if ( !isObject( options ) ) { 52 return new TypeError( 'invalid argument. Options must be an object. Value: `' + options + '`.' ); 53 } 54 if ( hasOwnProp( options, 'alpha' ) ) { 55 opts.alpha = options.alpha; 56 if ( !isNumber( opts.alpha ) || isnan( opts.alpha ) ) { 57 return new TypeError( 'invalid option. `alpha` option must be a number primitive. Option: `' + opts.alpha + '`.' ); 58 } 59 if ( opts.alpha < 0.0 || opts.alpha > 1.0 ) { 60 return new RangeError( 'invalid option. `alpha` must be a number in [0,1].' ); 61 } 62 } 63 return null; 64 } 65 66 67 // EXPORTS // 68 69 module.exports = validate;