Package Exports

@stdlib/boolean-ctor
@stdlib/boolean-ctor/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/boolean-ctor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Boolean

Boolean constructor.

Installation

npm install @stdlib/boolean-ctor

Usage

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

Boolean( value )

Returns a Boolean object, which is an object wrapper for a primitive boolean value.

var b = new Boolean( null );
// returns <Boolean>

When invoked without new, the function converts an input value to a primitive boolean value.

var b = Boolean( null );
// returns false

Methods

Boolean.prototype.toString()

Returns a string representation of the boolean value.

var b = new Boolean( true );
var str = b.toString();
// returns 'true'

Boolean.prototype.valueOf()

Returns the primitive value of the boolean object.

var b = new Boolean( true );
var val = b.valueOf();
// returns true

b = new Boolean();
val = b.valueOf();
// returns false

Notes

When invoked without new,
- if provided false, null, undefined, -0, 0, NaN, or an empty string, the function returns false.
- if provided any other value, including an empty object, an empty array, the string 'false', or a Boolean object (including a Boolean object whose value is false), the function returns true.
When invoked with new, the value of the returned Boolean object adheres to the same conversion semantics as when the constructor is invoked without new.

Examples

var format = require( '@stdlib/string-format' );
var Bool = require( '@stdlib/boolean-ctor' );

var values = [
    '5',
    5,
    0,
    NaN,
    true,
    false,
    null,
    void 0,
    [],
    {}
];

var i;
for ( i = 0; i < values.length; i++ ) {
    console.log( format( '%s => %s', JSON.stringify( values[ i ] ), ( Bool( values[ i ] ) ) ? 'true' : '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.

@stdlib/boolean-ctor