aboutsummaryrefslogtreecommitdiff
path: root/node_modules/boolean/README.md
diff options
context:
space:
mode:
authorPriyansh <[email protected]>2020-12-22 17:49:59 +0530
committerPriyansh <[email protected]>2020-12-22 17:49:59 +0530
commite93da8b04da86773247aadb1cbb1912e4f4526b2 (patch)
treeeb4ef3203a92ed3dbd2252ddb1ea23bd2d670c98 /node_modules/boolean/README.md
parenta5743c293dcb435e4b159a4df791f8955a4110ec (diff)
downloadstyx-e93da8b04da86773247aadb1cbb1912e4f4526b2.tar.xz
styx-e93da8b04da86773247aadb1cbb1912e4f4526b2.zip
Rewriting Project
Diffstat (limited to 'node_modules/boolean/README.md')
-rw-r--r--node_modules/boolean/README.md67
1 files changed, 67 insertions, 0 deletions
diff --git a/node_modules/boolean/README.md b/node_modules/boolean/README.md
new file mode 100644
index 0000000..17384dc
--- /dev/null
+++ b/node_modules/boolean/README.md
@@ -0,0 +1,67 @@
+# 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=master) |
+| 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 } = require('boolean');
+```
+
+If you use TypeScript, use the following code instead:
+
+```typescript
+import { boolean } 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)
+
+_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 quality assurance
+
+To run quality assurance for this module use [roboter](https://www.npmjs.com/package/roboter):
+
+```shell
+$ npx roboter
+```