time-to-botec

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

validate.js (4645B)

      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 isPlainObject = 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 isNonNegative = require( '@stdlib/assert/is-nonnegative-number' ).isPrimitive;
     27 var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
     28 var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
     29 var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
     30 
     31 
     32 // MAIN //
     33 
     34 /**
     35 * Validates function options.
     36 *
     37 * @private
     38 * @param {Object} opts - destination object
     39 * @param {Options} options - function options
     40 * @param {string} [options.sep] - separator used to join streamed data
     41 * @param {boolean} [options.objectMode] - specifies whether a stream should operate in object mode
     42 * @param {(string|null)} [options.encoding] - specifies how `Buffer` objects should be decoded to `strings`
     43 * @param {NonNegativeNumber} [options.highWaterMark] - specifies the maximum number of bytes to store in the internal buffer before ceasing to generate additional pseudorandom numbers
     44 * @param {NonNegativeInteger} [options.iter] - number of iterations
     45 * @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
     46 * @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
     47 * @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
     48 * @param {boolean} [options.copy] - boolean indicating whether to copy a provided pseudorandom number generator state
     49 * @param {PositiveInteger} [options.siter] - number of iterations after which to emit the PRNG state
     50 * @returns {(Error|null)} null or an error object
     51 *
     52 * @example
     53 * var opts = {};
     54 * var options = {
     55 *     'objectMode': true
     56 * };
     57 * var err= validate( opts, options );
     58 * if ( err ) {
     59 *     throw err;
     60 * }
     61 */
     62 function validate( opts, options ) {
     63 	if ( !isPlainObject( options ) ) {
     64 		return new TypeError( 'invalid argument. Options must be an object. Value: `' + options + '`.' );
     65 	}
     66 	if ( hasOwnProp( options, 'sep' ) ) {
     67 		opts.sep = options.sep;
     68 		if ( !isString( opts.sep ) ) {
     69 			return new TypeError( 'invalid option. `sep` option must be a primitive string. Option: `' + opts.sep + '`.' );
     70 		}
     71 	}
     72 	if ( hasOwnProp( options, 'objectMode' ) ) {
     73 		opts.objectMode = options.objectMode;
     74 		if ( !isBoolean( opts.objectMode ) ) {
     75 			return new TypeError( 'invalid option. `objectMode` option must be a primitive boolean. Option: `' + opts.objectMode + '`.' );
     76 		}
     77 	}
     78 	if ( hasOwnProp( options, 'encoding' ) ) {
     79 		opts.encoding = options.encoding;
     80 		if ( !isString( opts.encoding ) && opts.encoding !== null ) {
     81 			return new TypeError( 'invalid option. `encoding` option must be a primitive string or null. Option: `' + opts.encoding + '`.' );
     82 		}
     83 	}
     84 	if ( hasOwnProp( options, 'highWaterMark' ) ) {
     85 		opts.highWaterMark = options.highWaterMark;
     86 		if ( !isNonNegative( opts.highWaterMark ) ) {
     87 			return new TypeError( 'invalid option. `highWaterMark` option must be a nonnegative number. Option: `' + opts.highWaterMark + '`.' );
     88 		}
     89 	}
     90 	if ( hasOwnProp( options, 'iter' ) ) {
     91 		opts.iter = options.iter;
     92 		if ( !isNonNegativeInteger( opts.iter ) ) {
     93 			return new TypeError( 'invalid option. `iter` option must be a nonnegative integer. Option: `' + opts.iter + '`.' );
     94 		}
     95 	}
     96 	if ( hasOwnProp( options, 'siter' ) ) {
     97 		opts.siter = options.siter;
     98 		if ( !isPositiveInteger( opts.siter ) ) {
     99 			return new TypeError( 'invalid option. `siter` option must be a positive integer. Option: `' + opts.siter + '`.' );
    100 		}
    101 	}
    102 	// Pass through options...
    103 	if ( hasOwnProp( options, 'prng' ) ) {
    104 		opts.prng = options.prng;
    105 	}
    106 	if ( hasOwnProp( options, 'seed' ) ) {
    107 		opts.seed = options.seed;
    108 	}
    109 	if ( hasOwnProp( options, 'state' ) ) {
    110 		opts.state = options.state;
    111 	}
    112 	if ( hasOwnProp( options, 'copy' ) ) {
    113 		opts.copy = options.copy;
    114 	}
    115 	return null;
    116 }
    117 
    118 
    119 // EXPORTS //
    120 
    121 module.exports = validate;