Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wkovacs64/booleanize
A small utility to coerce a value to its boolean equivalent.
https://github.com/wkovacs64/booleanize
Last synced: 5 days ago
JSON representation
A small utility to coerce a value to its boolean equivalent.
- Host: GitHub
- URL: https://github.com/wkovacs64/booleanize
- Owner: wKovacs64
- License: mit
- Created: 2020-01-29T22:08:25.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-03T06:30:43.000Z (10 days ago)
- Last Synced: 2024-11-03T07:20:16.441Z (10 days ago)
- Language: TypeScript
- Homepage:
- Size: 3.36 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @wkovacs64/booleanize
_A small utility to coerce a value to its boolean equivalent._
[![npm Version][npm-image]][npm-url] [![Build Status][ci-image]][ci-url]
[![Code Coverage][coverage-image]][coverage-url]
## Installation
```
npm install @wkovacs64/booleanize
```
## Usage
The primary purpose of this package is to deal with environment variables received as strings. For
example, `SOME_CONDITIONAL=false` will be truthy if you just pass it to the `Boolean` constructor as
it comes through as a non-empty string. Instead, pass it to `booleanize` and you will get the value
back that I expect. Please note that it may not be the value YOU expect, but I created this
primarily for myself. 🙂
Basically, the following strings are considered falsy:
- `'null'`
- `'undefined'`
- `'false'`
- `'no'`
- `'0'`
### Example
```
# .env
SOME_CONDITIONAL=false
```
```ts
import { booleanize } from '@wkovacs64/booleanize';
Boolean(process.env.SOME_CONDITIONAL); // true 😕
booleanize(process.env.SOME_CONDITIONAL); // false 😊
```
## License
This module is distributed under the [MIT License][license].
[npm-image]: https://img.shields.io/npm/v/@wkovacs64/booleanize.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/@wkovacs64/booleanize
[ci-image]:
https://img.shields.io/github/actions/workflow/status/wKovacs64/booleanize/ci.yml?logo=github&style=flat-square
[ci-url]: https://github.com/wKovacs64/booleanize/actions?query=workflow%3Aci
[coverage-image]:
https://img.shields.io/codecov/c/github/wKovacs64/booleanize/main.svg?style=flat-square
[coverage-url]: https://codecov.io/gh/wKovacs64/booleanize/branch/main
[license]: https://github.com/wKovacs64/booleanize/tree/main/LICENSE