Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/welingtonms/logical
Execute, chain & compose logical operations.
https://github.com/welingtonms/logical
and boolean boolean-logic javascript logic-gates logical-operators nand or xor
Last synced: about 1 month ago
JSON representation
Execute, chain & compose logical operations.
- Host: GitHub
- URL: https://github.com/welingtonms/logical
- Owner: welingtonms
- License: mit
- Created: 2021-02-15T16:08:31.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-04T13:24:50.000Z (almost 2 years ago)
- Last Synced: 2024-10-24T09:23:42.712Z (about 2 months ago)
- Topics: and, boolean, boolean-logic, javascript, logic-gates, logical-operators, nand, or, xor
- Language: JavaScript
- Homepage:
- Size: 943 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# logical
[](https://coveralls.io/github/welingtonms/logical)
[](https://www.npmjs.com/package/@welingtonms/logical)
[](https://github.com/welingtonms/logical/actions/workflows/test.yml)
I have always been fascinated by the simplicity of logical operations and how you can express complex logical structures using it.
That's why I wrote this library, to provides a toolset to perform and chain logical operations.
It follows Javascript's default [_truthy_](https://developer.mozilla.org/en-US/docs/Glossary/Truthy) and [_falsy_](https://developer.mozilla.org/en-US/docs/Glossary/Falsy) definitions.
## Instalation
You can add this hook as a dependency by running `npm install @welingtonms/logical` or `yarn add @welingtonms/logical`.
## Supported operations
### AND
- Accepts multiple parameters. Evaluation occurs from left to right.
```js
import { and } from '@welingtonms/logical';
and( true, true, true ); // true
and( true, false ); // false
```
| A | B | Output |
| ------- | :-----: | ------: |
| `true` | `true` | `true` |
| `true` | `false` | `false` |
| `false` | `true` | `false` |
| `false` | `false` | `false` |
### OR
- Accepts multiple parameters. Evaluation occurs from left to right.
```js
import { or } from '@welingtonms/logical';
or( false, false, true ); // true
or( false, false ); // false
```
| A | B | Output |
| ------- | :-----: | ------: |
| `true` | `true` | `true` |
| `true` | `false` | `true` |
| `false` | `true` | `true` |
| `false` | `false` | `false` |
### XOR
- Accepts two parameters.
```js
import { xor } from '@welingtonms/logical';
xor( true, false ); // true
xor( false, false ); // false
```
| A | B | Output |
| ------- | :-----: | ------: |
| `true` | `true` | `false` |
| `true` | `false` | `true` |
| `false` | `true` | `true` |
| `false` | `false` | `false` |
### NOT
- Accepts one parameter.
```js
import { not } from '@welingtonms/logical';
xor( true, false ); // true
xor( false, false ); // false
```
| A | B | Output |
| ------- | :-----: | ------: |
| `true` | `true` | `true` |
| `true` | `false` | `true` |
| `false` | `true` | `true` |
| `false` | `false` | `false` |
### NAND
- Accepts multiple parameters. Evaluation occurs from left to right.
```js
import { nand } from '@welingtonms/logical';
nand( true, true, true ); // true
nand( true, false ); // false
```
| A | B | Output |
| ------- | :-----: | ------: |
| `true` | `true` | `false` |
| `true` | `false` | `true` |
| `false` | `true` | `true` |
| `false` | `false` | `true` |
### NOR
- Accepts multiple parameters. Evaluation occurs from left to right.
```js
import { nor } from '@welingtonms/logical';
nor( true, true, true ); // true
nor( true, false ); // false
```
| A | B | Output |
| ------- | :-----: | ------: |
| `true` | `true` | `false` |
| `true` | `false` | `false` |
| `false` | `true` | `false` |
| `false` | `false` | `true` |
### XNOR
- Accepts two parameters.
```js
import { xnor } from '@welingtonms/logical';
xnor( true, false ); // true
xnor( false, false ); // false
```
| A | B | Output |
| ------- | :-----: | ------: |
| `true` | `true` | `true` |
| `true` | `false` | `false` |
| `false` | `true` | `false` |
| `false` | `false` | `true` |
## Usage guide
You can also chain operations using default export `logical`.
First you need to call it with the appropriate initial value (which will depend on the operations you will perform).
When you are done chaining operations, you can call `value()` to get the result.
```js
import logical from '@welingtonms/logical';
console.log( logical( true ).value() ); // true
console.log( logical( false ).value() ); // false
console.log( logical( true ).xor( false ).value() ); // true
```