104 lines
3.6 KiB
JavaScript
104 lines
3.6 KiB
JavaScript
/**
|
|
* @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 isObject = 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 isFunction = require( '@stdlib/assert/is-function' );
|
|
|
|
|
|
// 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 pausing streaming
|
|
* @param {Function} [options.serialize] - custom serialization function
|
|
* @param {integer} [options.dir] - iteration direction
|
|
* @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 ( !isObject( 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, 'serialize' ) ) {
|
|
opts.serialize = options.serialize;
|
|
if ( !isFunction( opts.serialize ) ) {
|
|
return new TypeError( 'invalid option. `serialize` option must be a function. Option: `' + opts.serialize + '`.' );
|
|
}
|
|
}
|
|
if ( hasOwnProp( options, 'dir' ) ) {
|
|
opts.dir = options.dir;
|
|
if ( opts.dir !== 1 && opts.dir !== -1 ) {
|
|
return new TypeError( 'invalid option. `dir` option must be either `1` or `-1`. Option: `' + opts.dir + '`.' );
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
|
|
// EXPORTS //
|
|
|
|
module.exports = validate;
|