time-to-botec

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

validate.js (2444B)

      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 
     28 
     29 // MAIN //
     30 
     31 /**
     32 * Validates function options.
     33 *
     34 * @private
     35 * @param {Object} opts - destination object
     36 * @param {Options} options - function options
     37 * @param {*} [options.thisArg] - execution context
     38 * @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time
     39 * @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
     40 * @returns {(Error|null)} null or an error object
     41 *
     42 * @example
     43 * var opts = {};
     44 * var options = {
     45 *     'thisArg': {},
     46 *     'series': false,
     47 *     'limit': 10
     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, 'thisArg' ) ) {
     59 		opts.thisArg = options.thisArg;
     60 	}
     61 	if ( hasOwnProp( options, 'series' ) ) {
     62 		opts.series = options.series;
     63 		if ( !isBoolean( opts.series ) ) {
     64 			return new TypeError( 'invalid option. `series` option must be a boolean primitive. Option: `' + opts.series + '`.' );
     65 		}
     66 	}
     67 	if ( hasOwnProp( options, 'limit' ) ) {
     68 		opts.limit = options.limit;
     69 		if ( !isPositiveInteger( opts.limit ) ) {
     70 			return new TypeError( 'invalid option. `limit` option must be a positive integer. Option: `' + opts.limit + '`.' );
     71 		}
     72 	}
     73 	return null;
     74 }
     75 
     76 
     77 // EXPORTS //
     78 
     79 module.exports = validate;