README

Boolean Primitive

Validates if a value is a boolean primitive.

Installation

$ npm install validate.io-boolean-primitive

For use in the browser, use browserify.

Usage

var isBoolean = require( 'validate.io-boolean-primitive' );

isBoolean( value )

Validates if a value is a boolean primitive.

var value = false;

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

Examples

var isBoolean = require( 'validate.io-boolean-primitive' );

console.log( isBoolean( false ) );
// returns true

console.log( isBoolean( true ) );
// returns true

console.log( isBoolean( new Boolean( true ) ) );
// returns false

console.log( isBoolean( 5 ) );
// returns false

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

validate.io-boolean-primitive

Usage no npm install needed!