LiamDormon / qbcore.js

Type definitions for QBCore Framework Fivem

QBCore.js

About

This is a JavaScript/TypeScript wrapper for the QBCore framework in FiveM, based on esx.js by itschip.

If you experience any issues, please post them in the Issues.

Guide

Installation

Run npm i qbcore.js to install the package. When this is done you are ready to use it.

Usage

So how do you use it?

First you need to import either the Client class or Server class.

Client

import { Client } from 'qbcore.js'

let QBCore: Client = exports['qb-core'].GetCoreObject()

Server

import { Server } from 'qbcore.js'

let QBCore: Server = exports['qb-core'].GetCoreObject()

You can also import a single type:

import { Player } from 'qbcore.js/@types/server'

const Player: Player

Contributions and Additions are always welcome!