validate.js (2406B)
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 isString = require( '@stdlib/assert/is-string' ).isPrimitive; 27 var isnan = require( '@stdlib/assert/is-nan' ); 28 29 30 // MAIN // 31 32 /** 33 * Validates function options. 34 * 35 * @private 36 * @param {Object} opts - destination for validated options 37 * @param {Options} options - function options 38 * @param {number} [options.alpha] - significance level 39 * @param {string} [options.alternative] - alternative hypothesis 40 * @returns {(null|Error)} null or an error 41 * 42 * @example 43 * var opts = {}; 44 * 45 * var options = { 46 * 'alpha': 0.05, 47 * 'alernative': 'two-sided' 48 * }; 49 * 50 * var err = validate( opts, options ); 51 * if ( err ) { 52 * throw err; 53 * } 54 */ 55 function validate( opts, options ) { 56 if ( !isObject( options ) ) { 57 return new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' ); 58 } 59 if ( hasOwnProp( options, 'alpha' ) ) { 60 opts.alpha = options.alpha; 61 if ( !isNumber( opts.alpha ) || isnan( opts.alpha ) ) { 62 return new TypeError( 'invalid option. `alpha` option must be a number primitive. Option: `' + opts.alpha + '`.' ); 63 } 64 if ( opts.alpha < 0.0 || opts.alpha > 1.0 ) { 65 return new RangeError( 'invalid option. `alpha` option must be on the interval [0,1]. Option: `' + opts.alpha + '`.' ); 66 } 67 } 68 if ( hasOwnProp( options, 'alternative' ) ) { 69 opts.alternative = options.alternative; 70 if ( !isString( opts.alternative ) ) { 71 return new TypeError( 'invalid option. `alternative` option must be a string primitive. Option: `' + opts.alternative + '`.' ); 72 } 73 } 74 return null; 75 } 76 77 78 // EXPORTS // 79 80 module.exports = validate;