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