feat: update namespace TypeScript declarations

stdlib-bot · kgryte · web-flow · commit 3edcfe5d814f · 2024-06-05T02:20:38.000-07:00
PR-URL: stdlib-js#2303 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
diff --git a/lib/node_modules/@stdlib/array/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/docs/types/index.d.ts
@@ -21,6 +21,7 @@
 /* eslint-disable max-lines */
 
 import base = require( '@stdlib/array/base' );
+import BooleanArray = require( '@stdlib/array/bool' );
 import ArrayBuffer = require( '@stdlib/array/buffer' );
 import cartesianPower = require( '@stdlib/array/cartesian-power' );
 import cartesianProduct = require( '@stdlib/array/cartesian-product' );
@@ -120,6 +121,70 @@ interface Namespace {
 	*/
 	base: typeof base;
 
+	/**
+	* Boolean array constructor.
+	*
+	* @param arg - length, typed array, array-like object, or buffer
+	* @param byteOffset - byte offset (default: 0)
+	* @param length - view length
+	* @throws if provided only a single argument, must provide a valid argument
+	* @throws byte offset must be a nonnegative integer
+	* @throws must provide sufficient memory to accommodate byte offset and view length requirements
+	* @returns boolean array
+	*
+	* @example
+	* var arr = new ns.BooleanArray();
+	* // returns <ns.BooleanArray>
+	*
+	* var len = arr.length;
+	* // returns 0
+	*
+	* @example
+	* var arr = new ns.BooleanArray( 2 );
+	* // returns <ns.BooleanArray>
+	*
+	* var len = arr.length;
+	* // returns 2
+	*
+	* @example
+	* var arr = new ns.BooleanArray( [ true, false ] );
+	* // returns <ns.BooleanArray>
+	*
+	* var len = arr.length;
+	* // returns 2
+	*
+	* @example
+	* var ArrayBuffer = require( '@stdlib/array/buffer' );
+	*
+	* var buf = new ArrayBuffer( 16 );
+	* var arr = new ns.BooleanArray( buf );
+	* // returns <ns.BooleanArray>
+	*
+	* var len = arr.length;
+	* // returns 16
+	*
+	* @example
+	* var ArrayBuffer = require( '@stdlib/array/buffer' );
+	*
+	* var buf = new ArrayBuffer( 16 );
+	* var arr = new ns.BooleanArray( buf, 8 );
+	* // returns <ns.BooleanArray>
+	*
+	* var len = arr.length;
+	* // returns 8
+	*
+	* @example
+	* var ArrayBuffer = require( '@stdlib/array/buffer' );
+	*
+	* var buf = new ArrayBuffer( 32 );
+	* var arr = new ns.BooleanArray( buf, 8, 2 );
+	* // returns <ns.BooleanArray>
+	*
+	* var len = arr.length;
+	* // returns 2
+	*/
+	BooleanArray: typeof BooleanArray;
+
 	/**
 	* Constructor which returns an object used to represent a generic, fixed-length raw binary data buffer.
 	*/
diff --git a/lib/node_modules/@stdlib/complex/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/base/docs/types/index.d.ts
@@ -20,19 +20,13 @@
 
 /* eslint-disable max-lines */
 
-import assert = require( '@stdlib/complex/base/assert' );
 import cast = require( '@stdlib/complex/base/cast-return' );
 import wrap = require( '@stdlib/complex/base/wrap-function' );
 
 /**
 * Interface describing the `base` namespace.
 */
 interface Namespace {
-	/**
-	* Base complex number assert functions.
-	*/
-	assert: typeof assert;
-
 	/**
 	* Wraps an n-ary function and casts a function's return value to a complex number.
 	*
