Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Jun 17, 2024
1 parent 06743ed commit 9cc1f91
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

##### Features

- [`d626ffa`](https://github.com/stdlib-js/stdlib/commit/d626ffac9f0504be236c94afd4b920032272c8bf) - update namespace TypeScript declarations [(#2394)](https://github.com/stdlib-js/stdlib/pull/2394)
- [`4fdb218`](https://github.com/stdlib-js/stdlib/commit/4fdb218a0272d18ce2f70d769695bceca33a7653) - add `isBooleanArray` to namespace
- [`57347fd`](https://github.com/stdlib-js/stdlib/commit/57347fdd4382c4a71935e7ae06d992d04d08f802) - add `isBooleanDataType` to namespace

Expand Down Expand Up @@ -101,6 +102,7 @@ A total of 3 people contributed to this release. Thank you to the following cont

<details>

- [`d626ffa`](https://github.com/stdlib-js/stdlib/commit/d626ffac9f0504be236c94afd4b920032272c8bf) - **feat:** update namespace TypeScript declarations [(#2394)](https://github.com/stdlib-js/stdlib/pull/2394) _(by stdlib-bot, Athan Reines)_
- [`717af94`](https://github.com/stdlib-js/stdlib/commit/717af947ab270abc5422b6d8af7dacd8f0078ca4) - **docs:** update namespace table of contents [(##2389)](#2389) _(by stdlib-bot, Philipp Burckhardt)_
- [`4fdb218`](https://github.com/stdlib-js/stdlib/commit/4fdb218a0272d18ce2f70d769695bceca33a7653) - **feat:** add `isBooleanArray` to namespace _(by Athan Reines)_
- [`57347fd`](https://github.com/stdlib-js/stdlib/commit/57347fdd4382c4a71935e7ae06d992d04d08f802) - **feat:** add `isBooleanDataType` to namespace _(by Athan Reines)_
Expand Down
72 changes: 72 additions & 0 deletions docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
import contains = require( '@stdlib/array-base-assert-contains' );
import hasSameValues = require( '@stdlib/array-base-assert-has-same-values' );
import isAccessorArray = require( '@stdlib/array-base-assert-is-accessor-array' );
import isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' );
import isBooleanArray = require( '@stdlib/array-base-assert-is-booleanarray' );
import isComplexFloatingPointDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' );
import isComplexTypedArray = require( '@stdlib/array-base-assert-is-complex-typed-array' );
import isComplex64Array = require( '@stdlib/array-base-assert-is-complex64array' );
Expand Down Expand Up @@ -106,6 +108,76 @@ interface Namespace {
*/
isAccessorArray: typeof isAccessorArray;

/**
* Tests whether an input value is a supported array boolean data type.
*
* @param v - value to test
* @returns boolean indicating whether an input value is a supported array boolean data type
*
* @example
* var bool = ns.isBooleanDataType( 'bool' );
* // returns true
*
* bool = ns.isBooleanDataType( 'complex64' );
* // returns false
*
* bool = ns.isBooleanDataType( 'complex128' );
* // returns false
*
* bool = ns.isBooleanDataType( 'float32' );
* // returns false
*
* bool = ns.isBooleanDataType( 'float64' );
* // returns false
*
* bool = ns.isBooleanDataType( 'generic' );
* // returns false
*
* bool = ns.isBooleanDataType( 'int16' );
* // returns false
*
* bool = ns.isBooleanDataType( 'int32' );
* // returns false
*
* bool = ns.isBooleanDataType( 'int8' );
* // returns false
*
* bool = ns.isBooleanDataType( 'uint16' );
* // returns false
*
* bool = ns.isBooleanDataType( 'uint32' );
* // returns false
*
* bool = ns.isBooleanDataType( 'uint8' );
* // returns false
*
* bool = ns.isBooleanDataType( 'uint8c' );
* // returns false
*
* bool = ns.isBooleanDataType( 'foo' );
* // returns false
*/
isBooleanDataType: typeof isBooleanDataType;

/**
* Tests if a value is a `BooleanArray`.
*
* @param value - value to test
* @returns boolean indicating whether a value is a `BooleanArray`
*
* @example
* var BooleanArray = require( '@stdlib/array-bool' );
*
* var arr = new BooleanArray( 10 );
* var bool = ns.isBooleanArray( arr );
* // returns true
*
* @example
* var bool = ns.isBooleanArray( [] );
* // returns false
*/
isBooleanArray: typeof isBooleanArray;

/**
* Tests whether an input value is a supported array complex-valued floating-point data type.
*
Expand Down

0 comments on commit 9cc1f91

Please sign in to comment.