# node-fivem-api

Get FiveM server informations in NodeJS.

## Install

npm i node-fivem-api

## How to use

**Get players**

```js
const FiveM = require("node-fivem-api");

const srv = new FiveM("127.0.0.1:30120", {
  debug: true,
})
  .then(async (server) => {
    let players = await server.getPlayers();
    console.log(players);
  })
  .catch((err) => {
    console.log(err);
  });

// or

const srv = new FiveM("127.0.0.1:30120", {
  timeout: 5000,
});

async function someFunction() {
  const players = await srv.getPlayers();
  console.log(players);
}

someFunction();
```

**Get resources**

```js
const FiveM = require("node-fivem-api");

const srv = new FiveM("127.0.0.1:30120", {
  timeout: 5000,
})
  .then(async (server) => {
    let players = await server.getPlayers();
    console.log(players);
  })
  .catch((err) => {
    console.log(err);
  });

// or

const srv = new FiveM("127.0.0.1:30120", {
  timeout: 5000,
});

async function someFunction() {
  const resources = await srv.getResources();
  console.log(resources);
}

someFunction();
```

## Implemented functions

**Players**

- getPlayers (array)
- getPlayersCount (number)
- getMaxPlayers (number)

**Server informations**

- getResources (array)
- getTags (array)
- getGame (string)
- getLocation (string)
- getBuild (string)
- getLicenseKey (string)
- hasEnhancedHostSupport (bool)
- isOnesyncEnabled (bool)
- isScriptHookAllowed (bool)
- getServerData (object)
- isServerActive (bool)