42 lines
1.1 KiB
Markdown
42 lines
1.1 KiB
Markdown
# Simple CFX API Package
|
|
*This package is a cfx status package which uses CFX.re API.*
|
|
|
|
- **Install**
|
|
```bash
|
|
npm install cfx-status
|
|
```
|
|
|
|
## Utils
|
|
- Fetching General Status
|
|
- Fetching Components
|
|
- Get Component by ID
|
|
- Get Component by Name
|
|
|
|
## Usages
|
|
|
|
- **Basic Usage**
|
|
> *main.ts*
|
|
```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*
|
|
```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}`)
|
|
})();
|
|
``` |