Skip to content

Files

Latest commit

 

History

History

core

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 


Core for Statusify


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

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.