validate.js (1988B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2021 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 isArray = require( '@stdlib/assert/is-array' ); 24 var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive; 25 var isObject = require( '@stdlib/assert/is-plain-object' ); 26 var isnan = require( '@stdlib/assert/is-nan' ); 27 var hasOwnProp = require( '@stdlib/assert/has-own-property' ); 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 {Array} [options.groups] - array of group indicators 40 * @returns {(null|Error)} null or an error 41 */ 42 function validate( opts, options ) { 43 if ( !isObject( options ) ) { 44 return new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' ); 45 } 46 if ( hasOwnProp( options, 'alpha' ) ) { 47 opts.alpha = options.alpha; 48 if ( !isNumber( opts.alpha ) || isnan( opts.alpha ) ) { 49 return new TypeError( 'invalid option. `alpha` option must be a number primitive. Option: `' + opts.alpha + '`.' ); 50 } 51 } 52 if ( hasOwnProp( options, 'groups' ) ) { 53 opts.groups = options.groups; 54 if ( !isArray( opts.groups ) ) { 55 return new TypeError( 'invalid option. `groups` option must be an array. Option: `' + opts.groups + '`.' ); 56 } 57 } 58 return null; 59 } 60 61 62 // EXPORTS // 63 64 module.exports = validate;