cfx-status
v0.1.0
Published
Simple CFX.re Status Package using CFX.re Status API.
Downloads
119
Maintainers
Readme
Simple CFX API Package
This package is a cfx status package which uses CFX.re API.
- Install
npm install cfx-status
Utils
- Fetching General Status
- Fetching Components
- Get Component by ID
- Get Component by Name
Usages
- Basic Usage
main.ts
import CFXStatus from "cfx-status";
(async() => {
const cfxre = new CFXStatus()
// Automaticly Fetchs Components and General Status
const generalStatus = await cfxre.currentStatus // CFX.re Status
const components = await cfxre.components // CFX.re Systems Status
})();
- Advanced Usage
main.ts
import CFXStatus from "cfx-status";
(async() => {
const cfxre = new CFXStatus()
// Automaticly Fetchs Components and General Status
const wantedComponent = await cfxre.getComponentById("component-id")
const wantedComponentTwo = await cfxre.getComponentByName("component-name")
console.log(`${wantedComponent.name}: ${wantedComponent.status}`)
console.log(`${wantedComponentTwo.name}: ${wantedComponentTwo.status}`)
})();