@stdlib/assert-is-boolean

What is @stdlib/assert-is-boolean?

@stdlib/assert-is-boolean is a utility package that provides functions to check if a value is a boolean primitive or a boolean object.

What are @stdlib/assert-is-boolean's main functionalities?

Check if a value is a boolean primitive

This feature allows you to check if a given value is a boolean primitive. It returns true for boolean primitives and false for other types.

const isBoolean = require('@stdlib/assert-is-boolean').isPrimitive;
console.log(isBoolean(true)); // => true
console.log(isBoolean(false)); // => true
console.log(isBoolean('true')); // => false

Check if a value is a boolean object

This feature allows you to check if a given value is a boolean object. It returns true for boolean objects and false for other types.

const isBooleanObject = require('@stdlib/assert-is-boolean').isObject;
console.log(isBooleanObject(new Boolean(true))); // => true
console.log(isBooleanObject(true)); // => false

Check if a value is either a boolean primitive or a boolean object

This feature allows you to check if a given value is either a boolean primitive or a boolean object. It returns true for both boolean primitives and objects, and false for other types.

const isBoolean = require('@stdlib/assert-is-boolean');
console.log(isBoolean(true)); // => true
console.log(isBoolean(new Boolean(false))); // => true
console.log(isBoolean('false')); // => false

Other packages similar to @stdlib/assert-is-boolean

is-boolean-object

The 'is-boolean-object' package provides a function to check if a value is a boolean object. Unlike @stdlib/assert-is-boolean, it does not check for boolean primitives.

lodash.isboolean

The 'lodash.isboolean' package is part of the Lodash library and provides a function to check if a value is a boolean primitive. It does not check for boolean objects, making it less comprehensive compared to @stdlib/assert-is-boolean.

is-boolean

The 'is-boolean' package provides a function to check if a value is a boolean primitive. It is similar to the primitive check in @stdlib/assert-is-boolean but does not include checks for boolean objects.

README

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

isBoolean

Test if a value is a boolean.

Installation

npm install @stdlib/assert-is-boolean

Usage

var isBoolean = require( '@stdlib/assert-is-boolean' );

isBoolean( value )

Tests if a value is a boolean.

var Boolean = require( '@stdlib/boolean-ctor' );

var bool = isBoolean( false );
// returns true

bool = isBoolean( true );
// returns true

bool = isBoolean( new Boolean( false ) );
// returns true

bool = isBoolean( new Boolean( true ) );
// returns true

isBoolean.isPrimitive( value )

Tests if a value is a primitive boolean.

var Boolean = require( '@stdlib/boolean-ctor' );

var bool = isBoolean.isPrimitive( true );
// returns true

bool = isBoolean.isPrimitive( false );
// returns true

bool = isBoolean.isPrimitive( new Boolean( true ) );
// returns false

isBoolean.isObject( value )

Tests if a value is a Boolean object.

var Boolean = require( '@stdlib/boolean-ctor' );

var bool = isBoolean.isObject( true );
// returns false

bool = isBoolean.isObject( new Boolean( false ) );
// returns true

Examples

var Boolean = require( '@stdlib/boolean-ctor' );
var isBoolean = require( '@stdlib/assert-is-boolean' );

var bool = isBoolean( false );
// returns true

bool = isBoolean( new Boolean( false ) );
// returns true

bool = isBoolean( 'true' );
// returns false

bool = isBoolean( null );
// returns false

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.2.2 (2024-07-27)

<section class="commits">

Commits

<details>

• a8676e3 - bench: update assert/is-boolean benchmarks to measure affirmative/negative test values (#1458) (by Snehil Shah)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 1 person contributed to this release. Thank you to this contributor:

• Snehil Shah

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.2.1">