Back to @degenerate documentation Back to @degenerate packages documentation

@degenerate/rules Package

The @degenerate/rules package is a core component of the SAFE system, responsible for defining and enforcing various rules and policies within the system. This package provides a set of utilities and functions to manage and validate rules, ensuring that the system operates within the defined constraints and policies.

For detailed information in the rules framework, see the Rules Framework documentation.

Contents

1. Major Components
   1. Rule Creation
   2. Rule Evaluation
   3. Rule Validation
2. Installation
3. Usage
4. Test Data
5. Contributing
6. License
7. Support

Major Components

The degenerate/rules package is divided into three major components:

Rule Creation

Enables the creation and management of rules that govern the behavior of the system.

Rule creation contains the functions and services to create rules that that are designed and meet the criteria to be published to the SAFE ecosystem.

Rule Creation Directory

Rule Evaluation

Provides utilities to take the existing data, proposed data changes and rule sets and evaluate whether the proposed changes are valid.

Rule evaluation contains the functions and services to evaluate the proposed data to ensure that the share data objects are consistent and maintain integrity in the SAFE Network. The @degenerate/rules package provides a set of utilities and functions to evaluate rules, ensuring that the system operates within the defined constraints and policies.

Rule Evaluation Directory

Rule Validation

Provides utilities to validate rules, shapes and data coming into the SAFE network.

Rule Validation ensures that all data and operations within the system adhere to the established rules and policies and will be valid in the SAFE network. The @degenerate/rules package provides a set of utilities and functions to manage and validate rules, ensuring that the system operates within the defined constraints and policies.

Rule Evaluation Directory

back to contents

Installation

To install the @degenerate/rules package, use the following command:

npm install @degenerate/rules

back to contents

Test Data

Test data is provided in the __testdata__ directory. This data is used to test the rule creation, evaluation and validation functions.

Test Data Directory

back to contents

Contributing

Contributions to the @degenerate/rules package are welcome. Please follow the guidelines outlined in the CONTRIBUTING.md file.

back to contents

License

This package is licensed under the ISC License. See the LICENSE file for more information.

back to contents

Support

For support and questions, please open an issue on the GitHub repository.

back to contents