blackbox-rules-service

A Blackbox service that utilises the blackbox-rules rulebase implementation.

Through the init() function, the rule service is automatically created for the Blackbox API rulebase. The services are added to the Blackbox IOC container for use by a Blackbox server (typically generated via the Blackbox CLI).

For further information about the Blackbox Specification refer to the Blackbox website.

Table of Contents

• Install
• Usage
• API
• Maintainers
• Contributing
• License

Install

npm i blackbox-rules-service

Usage

Load services into Blackbox IOC container:

import init from 'blackbox-rules-service'

init()

This will create a Blackbox service named 'rulebase-service' in the IOC container. Note that serialisers and deserialisers from blackbox-rules-utils will also be loaded into the IOC container if not already loaded.

The 'rulebase-service' service depends on the 'rulebase' instance to already be loaded into the IOC container. A rulebase can be loaded as follows:

class RuleBaseFactory {
  @factory('rulebase')
  rulebase():RuleBase { return new DefaultRuleBase() }
}

See blackbox-rules-utils for instructions on creating a default RuleBase.

Generally the above two steps will be all you will want to do - for example, the rulebase is named via a factory and init() is called from index.ts in a Blackbox server generated with the Blackbox CLI. However, sometimes you may wish to access the rule service. This is easily done through autowiring:

class MyClass {
  @autowiredService('rule-service')
  ruleService:any
}

Maintainers

@ellipsistechnology

Contributing

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2019 Ben Millar