validate_options.js (1904B)
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 isPlainObject = require( '@stdlib/assert/is-plain-object' ); 24 var hasOwnProp = require( '@stdlib/assert/has-own-property' ); 25 var contains = require( '@stdlib/assert/contains' ); 26 var POLICIES = require( './policies.json' ); 27 28 29 // MAIN // 30 31 /** 32 * Validates function options. 33 * 34 * @private 35 * @param {Object} opts - destination object 36 * @param {Object} options - options 37 * @param {string} [options.output_dtype_policy] - policy for determining the output array data type 38 * @returns {(Error|null)} null or an error object 39 * 40 * @example 41 * var opts = {}; 42 * var options = { 43 * 'output_dtype_policy': 'float' 44 * }; 45 * var err = validate( opts, options ); 46 * if ( err ) { 47 * throw err; 48 * } 49 */ 50 function validate( opts, options ) { 51 if ( !isPlainObject( options ) ) { 52 return new TypeError( 'invalid argument. Options argument must be a plain object. Value: `' + options + '`.' ); 53 } 54 if ( hasOwnProp( options, 'output_dtype_policy' ) ) { 55 opts.policy = options.output_dtype_policy; 56 if ( !contains( POLICIES, opts.policy ) ) { 57 return new TypeError( 'invalid option. `output_dtype_policy` option must be a recognized/supported output array data type policy. Option: `' + opts.policy + '`.' ); 58 } 59 } 60 return null; 61 } 62 63 64 // EXPORTS // 65 66 module.exports = validate;