rbxts-pako/README.md
Erica Marigold 659cde4017
feat: prepare as pesde & npm package
* Add README with basic documentation
* Add exports.ts with required TS and Luau exports
* Add build script to extract Luau exports from exports.ts
* Setup pesde package manifest
* Apply formatting, setup stylua
2024-12-27 11:17:18 +00:00

811 B

pako-roblox-ts

Fork of pako for Roblox-TS.

Installation

Supported as a pesde (Luau) package and npm (roblox-ts) package:

# pesde
pesde add 0x5eal/pako

# roblox-ts
npm add @rbxts/pako

Usage

Luau

local serde = require("@lune/serde")
local pako = require("./luau_packages/pako")

local test = { my = "super", puper = { 456, 567 }, awesome = "pako" }
local compressed = pako.deflate(serde.encode("json", test))
local restored = serde.decode(pako.inflate(compressed, { to = "string" }))

roblox-ts

import pako from "@rbxts/pako";

const test = { my: "super", puper: [456, 567], awesome: "pako" };
const compressed = pako.deflate(JSON.stringify(test));
const restored = JSON.parse(pako.inflate(compressed, { to: "string" }));