/** * @license Apache-2.0 * * Copyright (c) 2018 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ 'use strict'; // MODULES // var isPlainObject = require( '@stdlib/assert/is-plain-object' ); var hasOwnProp = require( '@stdlib/assert/has-own-property' ); var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; var isNonNegative = require( '@stdlib/assert/is-nonnegative-number' ).isPrimitive; var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive; var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; // MAIN // /** * Validates function options. * * @private * @param {Object} opts - destination object * @param {Options} options - function options * @param {string} [options.sep] - separator used to join streamed data * @param {boolean} [options.objectMode] - specifies whether a stream should operate in object mode * @param {(string|null)} [options.encoding] - specifies how `Buffer` objects should be decoded to `strings` * @param {NonNegativeNumber} [options.highWaterMark] - specifies the maximum number of bytes to store in the internal buffer before ceasing to generate additional pseudorandom numbers * @param {NonNegativeInteger} [options.iter] - number of iterations * @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers * @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed * @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state * @param {boolean} [options.copy] - boolean indicating whether to copy a provided pseudorandom number generator state * @param {PositiveInteger} [options.siter] - number of iterations after which to emit the PRNG state * @returns {(Error|null)} null or an error object * * @example * var opts = {}; * var options = { * 'objectMode': true * }; * var err= validate( opts, options ); * if ( err ) { * throw err; * } */ function validate( opts, options ) { if ( !isPlainObject( options ) ) { return new TypeError( 'invalid argument. Options must be an object. Value: `' + options + '`.' ); } if ( hasOwnProp( options, 'sep' ) ) { opts.sep = options.sep; if ( !isString( opts.sep ) ) { return new TypeError( 'invalid option. `sep` option must be a primitive string. Option: `' + opts.sep + '`.' ); } } if ( hasOwnProp( options, 'objectMode' ) ) { opts.objectMode = options.objectMode; if ( !isBoolean( opts.objectMode ) ) { return new TypeError( 'invalid option. `objectMode` option must be a primitive boolean. Option: `' + opts.objectMode + '`.' ); } } if ( hasOwnProp( options, 'encoding' ) ) { opts.encoding = options.encoding; if ( !isString( opts.encoding ) && opts.encoding !== null ) { return new TypeError( 'invalid option. `encoding` option must be a primitive string or null. Option: `' + opts.encoding + '`.' ); } } if ( hasOwnProp( options, 'highWaterMark' ) ) { opts.highWaterMark = options.highWaterMark; if ( !isNonNegative( opts.highWaterMark ) ) { return new TypeError( 'invalid option. `highWaterMark` option must be a nonnegative number. Option: `' + opts.highWaterMark + '`.' ); } } if ( hasOwnProp( options, 'iter' ) ) { opts.iter = options.iter; if ( !isNonNegativeInteger( opts.iter ) ) { return new TypeError( 'invalid option. `iter` option must be a nonnegative integer. Option: `' + opts.iter + '`.' ); } } if ( hasOwnProp( options, 'siter' ) ) { opts.siter = options.siter; if ( !isPositiveInteger( opts.siter ) ) { return new TypeError( 'invalid option. `siter` option must be a positive integer. Option: `' + opts.siter + '`.' ); } } // Pass through options... if ( hasOwnProp( options, 'prng' ) ) { opts.prng = options.prng; } if ( hasOwnProp( options, 'seed' ) ) { opts.seed = options.seed; } if ( hasOwnProp( options, 'state' ) ) { opts.state = options.state; } if ( hasOwnProp( options, 'copy' ) ) { opts.copy = options.copy; } return null; } // EXPORTS // module.exports = validate;