# js-rule-management

> This project is designed to be a easy to understand and lightweight js module for rule management

Latest version **1.0.7** (published 2023-06-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install js-rule-management
pnpm add js-rule-management
yarn add js-rule-management
bun add js-rule-management
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2023-06-18 |
| First published | 2023-06-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 38.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | megamanjoker |

## Links

- npm: https://www.npmjs.com/package/js-rule-management
- Repository: https://github.com/Megamanjoker/js-rule-management
- Homepage: https://github.com/Megamanjoker/js-rule-management#readme
- Issues: https://github.com/Megamanjoker/js-rule-management/issues
- npm.io page: https://npm.io/package/js-rule-management

## Recent versions

- 1.0.7 (latest) — 2023-06-18
- 1.0.6 — 2023-06-18
- 1.0.5 — 2023-06-18
- 1.0.4 — 2023-06-18
- 1.0.3 — 2023-06-17
- 1.0.2 — 2023-06-17
- 1.0.1 — 2023-06-17
- 1.0.0 — 2023-06-17

## README

# js-rule-management
This project is designed to be a easy to understand and lightweight js module for rule management 

## What is a Rule?
A rule is a prescribed guideline or principle that governs behavior or actions in a particular context or system.

## What is a Rule Management System?
A rule management system is responsible for running all the rule's scripts that is given to it and outputting if they error to a result array on the management object.

## What is a Rule in the Context of this Program?
A rule has the following properties
- input - any data that you want to be inputted into the RunScript
- script - a function to be run by the rule management system

## What is a Rule Script?
A script is a javascript function that can do anything a normal javascript function can. You can even pass data into the function via the input property of the rule object.

## How do I know if a rule passed or failed?
any rule script that throws an error is considered a failed rule. 
any rule script that does not throw an error is considered a passing rule.

## What will the rule management system do with failed rules
the rule management system will collect all the rules and display the results of all the rules in a results array.

## What if I hand the rule management an object that is not a rule object
the rule management system will treat that object as in input into a function that looks like this ()=>{}

# Example of how to use the rule manager
    const ruleManager = new RuleManager()
    const expected = new Rule()
    ruleManager.push(expected)
    ruleManager.runRules()
    ruleManager.results

## Stretch Goal
implement a way to name the rules and have a descriptions on them

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