Package Exports

boolean

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 (boolean) 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 converts lots of things to boolean.

Installation

$ npm install boolean

Quick start

First you need to add a reference to boolean in your application.

var boolean = require('boolean');

To verify a value for its boolean value, call the boolean function and provide the value in question as parameter.

console.log(boolean('true')); // => true

The boolean function considers the following values to be equivalent to true:

true (boolean)
'true' (string)
'TRUE' (string)
't' (string)
'T' (string)
'yes (string)' (string)
'YES (string)' (string)
'y' (string)
'Y' (string)
'1' (string)
1 (number)

All other values, including undefined and null are considered to be false.

Running the build

This module can be built using Grunt. Besides running the tests, this also analyses the code. To run Grunt, go to the folder where you have installed boolean and run grunt. You need to have grunt-cli installed.

$ grunt

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.