validate.js (1550B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2020 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 isPlainObject = require( '@stdlib/assert/is-plain-object' ); 24 var hasOwnProp = require( '@stdlib/assert/has-own-property' ); 25 26 27 // MAIN // 28 29 /** 30 * Validates function options. 31 * 32 * @private 33 * @param {Object} opts - destination object 34 * @param {Options} options - function options 35 * @param {*} [options.invalid] - return value when an input iterator yields a non-numeric value 36 * @returns {(Error|null)} null or an error object 37 * 38 * @example 39 * var opts = {}; 40 * var options = { 41 * 'invalid': NaN 42 * }; 43 * var err = validate( opts, options ); 44 * if ( err ) { 45 * throw err; 46 * } 47 */ 48 function validate( opts, options ) { 49 if ( !isPlainObject( options ) ) { 50 return new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' ); 51 } 52 if ( hasOwnProp( options, 'invalid' ) ) { 53 opts.invalid = options.invalid; 54 } 55 return null; 56 } 57 58 59 // EXPORTS // 60 61 module.exports = validate;