Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -1 +1 @@
-Copyright (c) 2016-2023 The Stdlib Authors.
+Copyright (c) 2016-2024 The Stdlib Authors.

NOTICE

@@ -84,9 +84,9 @@ interface Constructor {
 	* @returns stream instance
 	*
 	* @example
-	* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
-	* var Float64Array = require( `@stdlib/array/float64` );
-	* var randu = require( `@stdlib/random/base/randu` );
+	* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
+	* var Float64Array = require( '@stdlib/array-float64' );
+	* var randu = require( '@stdlib/random-base-randu' );
 	*
 	* function log( chunk ) {
 	*    console.log( chunk.toString() );
@@ -125,9 +125,9 @@ interface Constructor {
 	* @returns stream instance
 	*
 	* @example
-	* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
-	* var Float64Array = require( `@stdlib/array/float64` );
-	* var randu = require( `@stdlib/random/base/randu` );
+	* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
+	* var Float64Array = require( '@stdlib/array-float64' );
+	* var randu = require( '@stdlib/random-base-randu' );
 	*
 	* function log( chunk ) {
 	*    console.log( chunk.toString() );
@@ -163,8 +163,8 @@ interface Constructor {
 	* @returns stream factory
 	*
 	* @example
-	* var Float64Array = require( `@stdlib/array/float64` );
-	* var randu = require( `@stdlib/random/base/randu` );
+	* var Float64Array = require( '@stdlib/array-float64' );
+	* var randu = require( '@stdlib/random-base-randu' );
 	*
 	* var arr = new Float64Array( 10 );
 	* var i;
@@ -202,9 +202,9 @@ interface Constructor {
 	* @returns stream instance
 	*
 	* @example
-	* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
-	* var Float64Array = require( `@stdlib/array/float64` );
-	* var randu = require( `@stdlib/random/base/randu` );
+	* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
+	* var Float64Array = require( '@stdlib/array-float64' );
+	* var randu = require( '@stdlib/random-base-randu' );
 	*
 	* function log( v ) {
 	*    console.log( v );
@@ -236,9 +236,9 @@ interface Constructor {
 * @returns stream instance
 *
 * @example
-* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
-* var Float64Array = require( `@stdlib/array/float64` );
-* var randu = require( `@stdlib/random/base/randu` );
+* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
+* var Float64Array = require( '@stdlib/array-float64' );
+* var randu = require( '@stdlib/random-base-randu' );
 *
 * function log( chunk ) {
 *    console.log( chunk.toString() );
@@ -260,8 +260,8 @@ interface Constructor {
 * stream.pipe( inspectStream( log ) );
 *
 * @example
-* var Float64Array = require( `@stdlib/array/float64` );
-* var randu = require( `@stdlib/random/base/randu` );
+* var Float64Array = require( '@stdlib/array-float64' );
+* var randu = require( '@stdlib/random-base-randu' );
 *
 * var arr = new Float64Array( 10 );
 * var i;
@@ -285,9 +285,9 @@ interface Constructor {
 * }
 *
 * @example
-* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
-* var Float64Array = require( `@stdlib/array/float64` );
-* var randu = require( `@stdlib/random/base/randu` );
+* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
+* var Float64Array = require( '@stdlib/array-float64' );
+* var randu = require( '@stdlib/random-base-randu' );
 *
 * function log( v ) {
 *    console.log( v );

dist/index.js

@@ -20,6 +20,8 @@
 
 // MODULES //
 
+var isObject = require( '@stdlib/assert-is-plain-object' );
+var format = require( '@stdlib/string-format' );
 var assign = require( '@stdlib/object-assign' );
 var CircularArrayStream = require( './main.js' );
 
@@ -37,6 +39,7 @@ var CircularArrayStream = require( './main.js' );
 * @param {Function} [options.serialize] - custom serialization function
 * @param {integer} [options.iter=1e308] - number of iterations
 * @param {integer} [options.dir=1] - iteration direction
+* @throws {TypeError} options argument must be an object
 * @returns {Function} stream factory
 *
 * @example
@@ -67,6 +70,9 @@ var CircularArrayStream = require( './main.js' );
 function factory( options ) {
 	var opts;
 	if ( arguments.length ) {
+		if ( !isObject( options ) ) {
+			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
+		}
 		opts = assign( {}, options );
 	} else {
 		opts = {};