Code Monkey home page Code Monkey logo

cfx.js's Introduction

CFX.JS

A simple NodeJS wrapper for the cfx.re project.

What does this do?

Currently this just supports GET requesting URLs on the FiveM server. But this also comes with nice type definitions for some files (/info.json, /dynamic.json) with the ability to support more.

How to use it?

The API is made to be used simply. Here is a basic example:

// use `.default` for type definitions
const cfx = require('@blocky/cfx.js').default;

(async () => {
    let server = cfx('http://localhost:3000');
    let serverInfo = await server.getInfo();

    console.log(serverInfo.artifactVersion);
})();

You can also use it to get custom endpoints set by resources:

// use `.default` for type definitions
const cfx = require('@blocky/cfx.js').default;

(async () => {
    let server = cfx('http://localhost:3000');
    let resData = await server.getPath('/my_resource');

    let { myData } = resData;
})();

Contributors

License

This project is maintained under the MIT license. More info can be viewed under LICENSE

cfx.js's People

Contributors

devblocky avatar dependabot-preview[bot] avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.