atcheck/lsscanner/new_ubuntu/node_modules/boolean/README.md

2.2 KiB

boolean

boolean converts lots of things to boolean.

Status

Category Status
Version npm
Dependencies David
Dev dependencies David
Build CircleCI
License GitHub

Installation

$ npm install boolean

Quick start

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

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

If you use TypeScript, use the following code instead:

import { boolean } 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)

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.

$ npx roboter