# boolstring

> Converts a string like true, on, or enabled into a boolean.

Latest version **2.0.1** (published 2024-07-28) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2024-07-28 |
| First published | 2019-03-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kalan Dominick |
| Maintainers | domkalan |
| Keywords | bool, string, eval |

## Links

- npm: https://www.npmjs.com/package/boolstring
- Repository: https://github.com/domkalan/boolString
- Homepage: https://github.com/domkalan/boolString#readme
- Issues: https://github.com/domkalan/boolString/issues
- npm.io page: https://npm.io/package/boolstring

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 2.0.1 (latest) — 2024-07-28
- 2.0.0 — 2024-07-28
- 1.0.2 — 2019-03-04
- 1.0.1 — 2019-03-04
- 1.0.0 — 2019-03-04

## README

# boolString
Converts a string like true, on, or enabled into a boolean.

## Install
Using Node.js (via npm)
```bash
npm install --save boolstring
```

Using Web Browser (via unpkg)
```HTML
<script src="https://unpkg.com/boolstring@2.0.1/index.js"></script>
```

## Example
```JavaScript
var yesString = "yes";

console.log(boolString(yesString)); // true

var noString = "no";

console.log(boolString(noString)); // false
```

## Supported Strings
Contributions are welcome to add more strings. To start, create a pull request (preferred) or an issue.

* `true`
* `yes`
* `enable`
* `enabled`
* `valid`
* `validated`
* `active`
* `activated`
* `permit`
* `permitted`
* `allow`
* `allowed`
* `pass`
* `passed`
* `on`
* `1`

## License
boolString is licensed under the open source MIT license. View the [LICENSE](https://github.com/domkalan/boolString/blob/master/LICENSE) file for more information.

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