From 943e1fcf2858bb0860825a939f26959e5754a567 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 5 Jun 2024 09:23:24 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 2 ++ docs/types/index.d.ts | 65 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 486ba807..5d9da053 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ ##### Features +- [`3edcfe5`](https://github.com/stdlib-js/stdlib/commit/3edcfe5d814fd12a56dbe492ddc78663721f5acd) - update namespace TypeScript declarations [(#2303)](https://github.com/stdlib-js/stdlib/pull/2303) - [`f4a14dd`](https://github.com/stdlib-js/stdlib/commit/f4a14dd55d10d1ce0390d24710c2998a3b112313) - add `BooleanArray` to namespace - [`0adcae5`](https://github.com/stdlib-js/stdlib/commit/0adcae51386086e2ef5fb5d78402389cff776deb) - update namespace TypeScript declarations [(#1340)](https://github.com/stdlib-js/stdlib/pull/1340) - [`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
+- [`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)_ - [`96e896a`](https://github.com/stdlib-js/stdlib/commit/96e896a39be08912b2e06dfb6b671ec13d042412) - **feat:** add support for boolean array indices _(by Athan Reines)_ - [`cc06b5c`](https://github.com/stdlib-js/stdlib/commit/cc06b5c8c67a1c8d1022920273535b29e5abf550) - **fix:** add missing generic parameter _(by Athan Reines)_ - [`f53180b`](https://github.com/stdlib-js/stdlib/commit/f53180b3c431857d7c918319da97bd8e3abcb216) - **fix:** add missing parameter _(by Athan Reines)_ diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 205e73c0..2fa6d004 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -21,6 +21,7 @@ /* eslint-disable max-lines */ import base = require( './../../base' ); +import BooleanArray = require( './../../bool' ); import ArrayBuffer = require( './../../buffer' ); import cartesianPower = require( './../../cartesian-power' ); import cartesianProduct = require( './../../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 + * + * var len = arr.length; + * // returns 0 + * + * @example + * var arr = new ns.BooleanArray( 2 ); + * // returns + * + * var len = arr.length; + * // returns 2 + * + * @example + * var arr = new ns.BooleanArray( [ true, false ] ); + * // returns + * + * var len = arr.length; + * // returns 2 + * + * @example + * var ArrayBuffer = require( './../../buffer' ); + * + * var buf = new ArrayBuffer( 16 ); + * var arr = new ns.BooleanArray( buf ); + * // returns + * + * var len = arr.length; + * // returns 16 + * + * @example + * var ArrayBuffer = require( './../../buffer' ); + * + * var buf = new ArrayBuffer( 16 ); + * var arr = new ns.BooleanArray( buf, 8 ); + * // returns + * + * var len = arr.length; + * // returns 8 + * + * @example + * var ArrayBuffer = require( './../../buffer' ); + * + * var buf = new ArrayBuffer( 32 ); + * var arr = new ns.BooleanArray( buf, 8, 2 ); + * // returns + * + * 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. */