validate.js (1996B)
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 isString = require( '@stdlib/assert/is-string' ).isPrimitive; 25 var isObject = require( '@stdlib/assert/is-plain-object' ); 26 27 28 // MAIN // 29 30 /** 31 * Validates function options. 32 * 33 * @private 34 * @param {Object} opts - destination for validated options 35 * @param {Options} options - function options 36 * @param {string} [options.copy] - string denoting whether to return a copy (`deep`, `shallow` or `none`) 37 * @returns {(null|Error)} null or an error 38 * 39 * @example 40 * var opts = {}; 41 * var options = { 42 * 'copy': 'shallow' 43 * }; 44 * var err = validate( opts, options ); 45 * if ( err ) { 46 * throw err; 47 * } 48 */ 49 function validate( opts, options ) { 50 if ( !isObject( options ) ) { 51 return new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' ); 52 } 53 if ( hasOwnProp( options, 'copy' ) ) { 54 opts.copy = options.copy; 55 if ( !isString( opts.copy ) ) { 56 return new TypeError( 'invalid option. `copy` option must be a string primitive. Option: `' + opts.copy + '`.' ); 57 } 58 if ( 59 opts.copy !== 'deep' && 60 opts.copy !== 'shallow' && 61 opts.copy !== 'none' 62 ) { 63 return new TypeError( 'invalid option. `copy` option must be `deep`, `shallow` or `none`. Value: `' + opts.copy + '`.' ); 64 } 65 } 66 return null; 67 } 68 69 70 // EXPORTS // 71 72 module.exports = validate;