# cfx-status

> Simple CFX.re Status Package using CFX.re Status API.

Latest version **0.1.0** (published 2023-11-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install cfx-status
pnpm add cfx-status
yarn add cfx-status
bun add cfx-status
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-11-04 |
| First published | 2023-11-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Lvorex |
| Maintainers | lvorex |
| Keywords | cfx-api, cfx.re, cfx, fivem, api, node, redm, fivem-api, redm-api |

## Links

- npm: https://www.npmjs.com/package/cfx-status
- Repository: https://github.com/lvorex/cfx-status
- Homepage: https://github.com/lvorex/cfx-status#readme
- Issues: https://github.com/lvorex/cfx-status/issues
- npm.io page: https://npm.io/package/cfx-status

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.6.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2023-11-04
- 0.1.0-dev2 — 2023-11-04
- 0.1.0-dev — 2023-11-04
- 0.0.9-dev — 2023-11-04
- 0.0.7 — 2023-11-04
- 0.0.7-dev — 2023-11-04

## README

# 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}`)
})();
```

---
_Source: https://npm.io/package/cfx-status · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._