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.

Status

Category	Status
Version
Dependencies
Dev dependencies
Build
License

Installation

$ npm install boolean

Quick start

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

const { boolean, isBooleanable } = require('boolean');

If you use TypeScript, use the following code instead:

import { boolean, isBooleanable } from '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)
• 'on' (string)
• 'ON' (string)
• '1' (string)
• 1 (number)

In addition to the primitive types mentioned above, boolean also supports their object wrappers Boolean, String, and Number.

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

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

Figuring out whether a value can be considered to be boolean

From time to time, you may not want to directly convert a value to its boolean equivalent, but explicitly check whether it looks like a boolean. E.g., although boolean('F') returns false, the string F at least looks like a boolean, in contrast to something such as 123 (for which boolean(123) would also return false).

To figure out whether a value can be considered to be a boolean, use the isBooleanable function:

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

The isBooleanable function considers all of the above mentioned values to be reasonable boolean values, and additionally, also the following ones:

• false (boolean)
• 'false' (string)
• 'FALSE' (string)
• 'f' (string)
• 'F' (string)
• 'no' (string)
• 'NO' (string)
• 'n' (string)
• 'N' (string)
• 'off' (string)
• 'OFF' (string)
• '0' (string)
• 0 (number)

Running quality assurance

To run quality assurance for this module use roboter:

$ npx roboter