@gwigz/sluaDocumentation
TypeScript implementation of SLua's tagged JSON codec
Note
This package is not for use inside TSTL pipelines. Use it in projects that communicate with SLua externally (e.g. web backends, bots, tools).
@gwigz/slua-json is a TypeScript implementation of SLua's
lljson.slencode/sldecode tagged JSON format. It lets Node.js and browser
code exchange typed data with SLua scripts over HTTP or any other transport,
vectors, quaternions, UUIDs, and buffers included.
Install
npm install @gwigz/slua-jsonQuick example
import { slencode, sldecode, Vector, Quaternion } from "@gwigz/slua-json"
// Decode tagged JSON received from an SLua script
const data = sldecode<{ pos: Vector; rot: Quaternion }>('{"pos":"!v<1,2,3>","rot":"!q<0,0,0,1>"}')
data.pos.x // 1
data.rot.w // 1
// Encode data for an SLua script to consume via lljson.sldecode
const json = slencode({ pos: new Vector(1, 2, 3) })
// -> '{"pos":"!v<1,2,3>"}'
// Use tight mode for smaller payloads
slencode(new Vector(0, 0, 1), { tight: true })
// -> '"!v,,1"'