# boolean

> boolean converts lots of things to boolean.

Latest version **3.2.0** (published 2022-02-16) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install boolean
pnpm add boolean
yarn add boolean
bun add boolean
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.2.0 |
| Published | 2022-02-16 |
| First published | 2014-12-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | thenativeweb-admin, goloroden, yeldir, nhummel, dotkuro |
| Keywords | boolean, parser |

## Links

- npm: https://www.npmjs.com/package/boolean
- Repository: https://github.com/thenativeweb/boolean
- Homepage: https://github.com/thenativeweb/boolean#readme
- Issues: https://github.com/thenativeweb/boolean/issues
- npm.io page: https://npm.io/package/boolean

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 3.2.0 (latest) — 2022-02-16
- 3.1.4 — 2021-08-19
- 3.1.3 — 2021-08-19
- 3.1.2 — 2021-06-10
- 3.1.1 — 2021-06-10
- 3.1.0 — 2021-05-30
- 3.0.4 — 2021-05-10
- 3.0.3 — 2021-03-25
- 3.0.2 — 2020-11-03
- 3.0.1 — 2020-02-11
- 3.0.0 — 2019-11-15
- 2.0.3 — 2019-11-01
- 2.0.2 — 2019-09-16
- 2.0.1 — 2019-09-16
- 1.0.0 — 2019-03-20
- … 7 more at https://npm.io/package/boolean/versions

## README

# boolean

boolean converts lots of things to boolean.

## Status

| Category         | Status                                                                                                                                     |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Version          | [![npm](https://img.shields.io/npm/v/boolean)](https://www.npmjs.com/package/boolean)                                                      |
| Dependencies     | ![David](https://img.shields.io/david/thenativeweb/boolean)                                                                                |
| Dev dependencies | ![David](https://img.shields.io/david/dev/thenativeweb/boolean)                                                                            |
| Build            | ![GitHub Actions](https://github.com/thenativeweb/boolean/workflows/Release/badge.svg?branch=main) |
| License          | ![GitHub](https://img.shields.io/github/license/thenativeweb/boolean)                                                                      |

## 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
```

---
_Source: https://npm.io/package/boolean · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._