validate.js (1809B)
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 isObject = require( '@stdlib/assert/is-plain-object' ); 24 var hasOwnProp = require( '@stdlib/assert/has-own-property' ); 25 var indexOf = require( './../../index-of' ); 26 27 28 // VARIABLES // 29 30 var returns = [ 'values', 'indices', '*' ]; 31 32 33 // MAIN // 34 35 /** 36 * Validates function options. 37 * 38 * @private 39 * @param {Object} opts - destination object 40 * @param {Options} options - function options 41 * @param {string} [options.returns] - output format 42 * @returns {(Error|null)} null or an error object 43 * 44 * @example 45 * var opts = {}; 46 * var options = { 47 * 'returns': '*' 48 * }; 49 * var err = validate( opts, options ); 50 * if ( err ) { 51 * throw err; 52 * } 53 */ 54 function validate( opts, options ) { 55 if ( !isObject( options ) ) { 56 return new TypeError( 'invalid argument. Options must be an object. Value: `' + options + '`.' ); 57 } 58 if ( hasOwnProp( options, 'returns' ) ) { 59 opts.returns = options.returns; 60 if ( indexOf( returns, opts.returns ) === -1 ) { 61 return new TypeError( 'invalid option. `returns` option must be one of the following: "' + returns.join( '", "' ) + '". Option: `' + opts.returns + '`.' ); 62 } 63 } 64 return null; 65 } 66 67 68 // EXPORTS // 69 70 module.exports = validate;