86 online 3 members  + Join RP Base  +
FreeScript

nuix

by laot7490  ·  version 2026.10.24  ·  updated 3 days ago

No reviews yet

Downloads
0
Reviews
0
Size
19 KB
Code check
Clean
Licence
MIT
Released
Nov 2026

Modular, type-safe TypeScript library for FiveM NUI projects. Zero runtime dependencies.

nuix
@laot/nuix
FiveM NUI helpers. No runtime deps. ESM + CJS + types.
Install
npm install @laot/nuix

API
Export, Use

fetchNui, Call Lua (RegisterNUICallback)
onNuiMessage / onNuiAction, Listen to SendNUIMessage
applyLtBatch / replaceLtState, Patch / full replace for LTBridge CreateState
isEnvBrowser / setResourceName / setNuiMocks, Browser / Vite dev

fetchNui
import { fetchNui, isEnvBrowser, setResourceName, setNuiMocks } from "@laot/nuix";

if (isEnvBrowser()) {
  setResourceName("myresource");
  setNuiMocks({ getPlayer: { name: "Dev", level: 99 } });
}

const player = await fetchNui("getPlayer", { id: 1 });

RegisterNUICallback("getPlayer", function(data, cb)
  cb({ name = "John", level = 42 })
end)

Messages
import { onNuiMessage, onNuiAction } from "@laot/nuix";

const off = onNuiMessage((data) => {
  console.log(data.action);
});

onNuiAction("UpdateLocale", (data) => {
  console.log(data.locale, data.translations);
});

off();

LTBridge CreateState
Lua LT.NUI.CreateState("UpdatePlayer", …) sends:

Message, Payload

UpdatePlayer, batch, deletes?
UpdatePlayer_sync, state
UpdatePlayer_set, state

Lua array paths are 1-based (items.1 → JS index 0).

applyLtBatch and replaceLtState mutate the target in place:

import { onNuiAction, applyLtBatch, replaceLtState } from "@laot/nuix";

onNuiAction("UpdatePlayer", (data) => {
  applyLtBatch(store.$state, data);
});

onNuiAction("UpdatePlayer_sync", (data) => {
  replaceLtState(store.$state, data.state ?? {});
});

onNuiAction("UpdatePlayer_set", (data) => {
  replaceLtState(store.$state, data.state ?? {});
});

With React state, clone first:

setPlayer((prev) => {
  const next = structuredClone(prev);
  applyLtBatch(next, { batch: data.batch, deletes: data.deletes });
  return next;
});

Migrating from 1.x
  • createFetchNui → fetchNui + setNuiMocks
  • Nested { action, data } messages → flat payload
  • Locale helpers removed — keep locale in your app
Build
npm run build
npm run typecheck

Node 18+.

MIT © LAOT