@statusify/core
v1.1.1-alpha.0
Published
The core of Statusify
Downloads
4
Maintainers
Readme
Features
- Incidents
- Metrics
- Severities
- Builder Pattern
- ASynchronous API
Technologies
Building
$ tsc
Usage
Constructing
Statusify needs to be initialized with Providers and a Severity Calculator, below is a list of included providers and calculators.
Providers
- Builder (Component + Severity)
- ArrayIncidentProvider (Incident)
Calculators
const statusify = new Statusify({
componentProvider: <ComponentProvider>,
incidentProvider: <IncidentProvider>,
severityProvider: <SeverityProvider>,
severityCalculator: <SeverityCalculator>,
});
Fetching Data
All APIs are asynchronous and must therefore be used with Promise#then or await, read more here.
Methods for fetching data can be found within the Statusify class.
Creating Custom Providers and Calculators
Custom providers can be created by implementing one or more of the following interfaces:
Custom calculators can be created by implementing the ICalculatesSeverities interface.