time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

validate.js (2923B)

      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 isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
     26 var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
     27 var indexOf = require( './../../../index-of' );
     28 
     29 
     30 // VARIABLES //
     31 
     32 var returns = [ 'values', 'indices', '*' ];
     33 
     34 
     35 // MAIN //
     36 
     37 /**
     38 * Validates function options.
     39 *
     40 * @private
     41 * @param {Object} opts - destination object
     42 * @param {Options} options - function options
     43 * @param {*} [options.thisArg] - execution context
     44 * @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time
     45 * @param {boolean} [options.series] - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection
     46 * @param {string} [options.returns] - output format
     47 * @returns {(Error|null)} null or an error object
     48 *
     49 * @example
     50 * var opts = {};
     51 * var options = {
     52 *     'thisArg': {},
     53 *     'series': false,
     54 *     'limit': 10,
     55 *     'returns': '*'
     56 * };
     57 * var err = validate( opts, options );
     58 * if ( err ) {
     59 *     throw err;
     60 * }
     61 */
     62 function validate( opts, options ) {
     63 	if ( !isObject( options ) ) {
     64 		return new TypeError( 'invalid argument. Options must be an object. Value: `' + options + '`.' );
     65 	}
     66 	if ( hasOwnProp( options, 'thisArg' ) ) {
     67 		opts.thisArg = options.thisArg;
     68 	}
     69 	if ( hasOwnProp( options, 'series' ) ) {
     70 		opts.series = options.series;
     71 		if ( !isBoolean( opts.series ) ) {
     72 			return new TypeError( 'invalid option. `series` option must be a boolean primitive. Option: `' + opts.series + '`.' );
     73 		}
     74 	}
     75 	if ( hasOwnProp( options, 'limit' ) ) {
     76 		opts.limit = options.limit;
     77 		if ( !isPositiveInteger( opts.limit ) ) {
     78 			return new TypeError( 'invalid option. `limit` option must be a positive integer. Option: `' + opts.limit + '`.' );
     79 		}
     80 	}
     81 	if ( hasOwnProp( options, 'returns' ) ) {
     82 		opts.returns = options.returns;
     83 		if ( indexOf( returns, opts.returns ) === -1 ) {
     84 			return new TypeError( 'invalid option. `returns` option must be one of the following: "' + returns.join( '", "' ) + '". Option: `' + opts.returns + '`.' );
     85 		}
     86 	}
     87 	return null;
     88 }
     89 
     90 
     91 // EXPORTS //
     92 
     93 module.exports = validate;