Skip to content

Commit 3edcfe5

Browse files
stdlib-botkgryte
andauthored
feat: update namespace TypeScript declarations
PR-URL: #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>
1 parent 7c36ea3 commit 3edcfe5

File tree

2 files changed

+65
-6
lines changed

2 files changed

+65
-6
lines changed

lib/node_modules/@stdlib/array/docs/types/index.d.ts

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
/* eslint-disable max-lines */
2222

2323
import base = require( '@stdlib/array/base' );
24+
import BooleanArray = require( '@stdlib/array/bool' );
2425
import ArrayBuffer = require( '@stdlib/array/buffer' );
2526
import cartesianPower = require( '@stdlib/array/cartesian-power' );
2627
import cartesianProduct = require( '@stdlib/array/cartesian-product' );
@@ -120,6 +121,70 @@ interface Namespace {
120121
*/
121122
base: typeof base;
122123

124+
/**
125+
* Boolean array constructor.
126+
*
127+
* @param arg - length, typed array, array-like object, or buffer
128+
* @param byteOffset - byte offset (default: 0)
129+
* @param length - view length
130+
* @throws if provided only a single argument, must provide a valid argument
131+
* @throws byte offset must be a nonnegative integer
132+
* @throws must provide sufficient memory to accommodate byte offset and view length requirements
133+
* @returns boolean array
134+
*
135+
* @example
136+
* var arr = new ns.BooleanArray();
137+
* // returns <ns.BooleanArray>
138+
*
139+
* var len = arr.length;
140+
* // returns 0
141+
*
142+
* @example
143+
* var arr = new ns.BooleanArray( 2 );
144+
* // returns <ns.BooleanArray>
145+
*
146+
* var len = arr.length;
147+
* // returns 2
148+
*
149+
* @example
150+
* var arr = new ns.BooleanArray( [ true, false ] );
151+
* // returns <ns.BooleanArray>
152+
*
153+
* var len = arr.length;
154+
* // returns 2
155+
*
156+
* @example
157+
* var ArrayBuffer = require( '@stdlib/array/buffer' );
158+
*
159+
* var buf = new ArrayBuffer( 16 );
160+
* var arr = new ns.BooleanArray( buf );
161+
* // returns <ns.BooleanArray>
162+
*
163+
* var len = arr.length;
164+
* // returns 16
165+
*
166+
* @example
167+
* var ArrayBuffer = require( '@stdlib/array/buffer' );
168+
*
169+
* var buf = new ArrayBuffer( 16 );
170+
* var arr = new ns.BooleanArray( buf, 8 );
171+
* // returns <ns.BooleanArray>
172+
*
173+
* var len = arr.length;
174+
* // returns 8
175+
*
176+
* @example
177+
* var ArrayBuffer = require( '@stdlib/array/buffer' );
178+
*
179+
* var buf = new ArrayBuffer( 32 );
180+
* var arr = new ns.BooleanArray( buf, 8, 2 );
181+
* // returns <ns.BooleanArray>
182+
*
183+
* var len = arr.length;
184+
* // returns 2
185+
*/
186+
BooleanArray: typeof BooleanArray;
187+
123188
/**
124189
* Constructor which returns an object used to represent a generic, fixed-length raw binary data buffer.
125190
*/

lib/node_modules/@stdlib/complex/base/docs/types/index.d.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,13 @@
2020

2121
/* eslint-disable max-lines */
2222

23-
import assert = require( '@stdlib/complex/base/assert' );
2423
import cast = require( '@stdlib/complex/base/cast-return' );
2524
import wrap = require( '@stdlib/complex/base/wrap-function' );
2625

2726
/**
2827
* Interface describing the `base` namespace.
2928
*/
3029
interface Namespace {
31-
/**
32-
* Base complex number assert functions.
33-
*/
34-
assert: typeof assert;
35-
3630
/**
3731
* Wraps an n-ary function and casts a function's return value to a complex number.
3832
*

0 commit comments

Comments
 (0)