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