boolean

What is boolean?

The 'boolean' npm package is a simple utility that helps in converting various types of values to a boolean. It is particularly useful when dealing with values that are expected to be true or false but may come in different formats, such as strings, numbers, or even undefined.

What are boolean's main functionalities?

Convert any value to a boolean

This feature allows you to convert various types of values, including strings, numbers, and null or undefined, to a strict boolean value. It is useful for ensuring that you are working with a true boolean in your logic.

const boolean = require('boolean');
console.log(boolean('true')); // true
console.log(boolean('false')); // false
console.log(boolean('1')); // true
console.log(boolean('0')); // false
console.log(boolean(1)); // true
console.log(boolean(0)); // false
console.log(boolean(undefined)); // false
console.log(boolean(null)); // false
console.log(boolean('yes')); // true
console.log(boolean('no')); // false

Other packages similar to boolean

to-bool

The 'to-bool' package is similar to 'boolean' in that it converts values to booleans. However, it may have different rules for conversion or additional/different features.

boolify

The 'boolify' package also converts values to booleans. It might offer a different API or conversion logic, which could make it more suitable for certain use cases compared to 'boolean'.

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.

const 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)
• 'YES' (string)
• 'y' (string)
• 'Y' (string)
• '1' (string)
• 1 (number)

Please note that if you provide a string, it will be trimmed.

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

Running the build

To build this module use roboter.

$ bot

License

The MIT License (MIT) Copyright (c) 2014-2017 the native web.

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.