1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
# boolean
boolean converts lots of things to boolean.
## Status
| Category | Status |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Version | [](https://www.npmjs.com/package/boolean) |
| Dependencies |  |
| Dev dependencies |  |
| Build |  |
| License |  |
## Installation
```shell
$ npm install boolean
```
## Quick start
First you need to add a reference to boolean in your application:
```javascript
const { boolean, isBooleanable } = require('boolean');
```
If you use TypeScript, use the following code instead:
```typescript
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:
```javascript
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:
```javascript
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](https://www.npmjs.com/package/roboter):
```shell
$ npx roboter
```
|
