npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fivem-stats

v1.0.0

Published

API for getting FiveM server info & status using node-fetch module

Downloads

107

Readme

FiveM Stats

API for getting FiveM server info & status now using node-fetch module.

Installation

npm install fivem-stats
npm i fivem-stats

Usage

Examples

See the server status (json)

const FiveM = require('fivem-stats'); //Import the module
const server = new FiveM.Stats('IPAddress:PORT'); //Set the server's IP Address and Port

server.getServerStatus().then(data => console.log(data)); //Get & log the Server Status!

//if online returns json {online: true}
// if offline returns json {online: false}

Get Player Count (in numbers)

const FiveM = require('fivem-stats'); //Import the module
const server = new FiveM.Stats('IPAddress:PORT'); //Set the server's IP Address and Port
 
server.getPlayers().then(data => console.log(data)) // Get & log the number of players online in the server!

Get all Resources

const FiveM = require('fivem-stats'); //Import the module
const server = new FiveM.Stats('IPAddress:PORT'); //Set the server's IP Address and Port
 
server.getResources().then(data => console.log(data)) // Get & Log the resources of server!

ALL FUNCTION REQUESTS

- getPlayers - Number of players online - (number)
- getPlayersAll - List all players in an array - (string)
- getMaxPlayers - Max players that are able to join the server - (number)
- getResources - Get resource names of all server resources - (string/array)
- getTags - Get all server tags - (string)
- getServer - Get the whole server object - (string)
- getOnesync - See if the server has OneSync enabled - (boolean)
- getLocale - The language of the server - (string)
- getGamename - Get the name of the server - (string)
- getEnhancedHostSupport - ... - (boolean)
- getlicenseKeyToken - The license key for the server - (string)
- getScriptHookAllowed - See if the server supports external mod menus from the client - (boolean)
- getBannerConnecting - Get the banner_connecting of the server - (string)
- getBannerDetail - Get the banner_detail of the server - (string)
- getServerDesc - Get server description (string) 

Credits:

This is a module that already existed but made using the axios module, I rewrote it using the node-fetch module and added some functions. https://github.com/JackCrispy/fivem - Official Module https://www.npmjs.com/package/fivem - Official package of npm