Skip to content

Commit 943e1fc

Browse files
committed
Auto-generated commit
1 parent 4af90de commit 943e1fc

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed

CHANGELOG.md

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

2121
##### Features
2222

23+
- [`3edcfe5`](https://github.com/stdlib-js/stdlib/commit/3edcfe5d814fd12a56dbe492ddc78663721f5acd) - update namespace TypeScript declarations [(#2303)](https://github.com/stdlib-js/stdlib/pull/2303)
2324
- [`f4a14dd`](https://github.com/stdlib-js/stdlib/commit/f4a14dd55d10d1ce0390d24710c2998a3b112313) - add `BooleanArray` to namespace
2425
- [`0adcae5`](https://github.com/stdlib-js/stdlib/commit/0adcae51386086e2ef5fb5d78402389cff776deb) - update namespace TypeScript declarations [(#1340)](https://github.com/stdlib-js/stdlib/pull/1340)
2526
- [`3bb9603`](https://github.com/stdlib-js/stdlib/commit/3bb9603cc344e09a31481c7ec75c17bd0d192e3c) - add `mskreject` to namespace
@@ -1633,6 +1634,7 @@ A total of 13 people contributed to this release. Thank you to the following con
16331634

16341635
<details>
16351636

1637+
- [`3edcfe5`](https://github.com/stdlib-js/stdlib/commit/3edcfe5d814fd12a56dbe492ddc78663721f5acd) - **feat:** update namespace TypeScript declarations [(#2303)](https://github.com/stdlib-js/stdlib/pull/2303) _(by stdlib-bot, Athan Reines)_
16361638
- [`96e896a`](https://github.com/stdlib-js/stdlib/commit/96e896a39be08912b2e06dfb6b671ec13d042412) - **feat:** add support for boolean array indices _(by Athan Reines)_
16371639
- [`cc06b5c`](https://github.com/stdlib-js/stdlib/commit/cc06b5c8c67a1c8d1022920273535b29e5abf550) - **fix:** add missing generic parameter _(by Athan Reines)_
16381640
- [`f53180b`](https://github.com/stdlib-js/stdlib/commit/f53180b3c431857d7c918319da97bd8e3abcb216) - **fix:** add missing parameter _(by Athan Reines)_

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( './../../base' );
24+
import BooleanArray = require( './../../bool' );
2425
import ArrayBuffer = require( './../../buffer' );
2526
import cartesianPower = require( './../../cartesian-power' );
2627
import cartesianProduct = require( './../../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( './../../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( './../../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( './../../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
*/

0 commit comments

Comments
 (0)