zstd-wasm

build with zstd-rs

how to use within vite

import init, { compress, decompress } from "@dweb-browser/zstd-wasm";
import zstd_wasm_url from "@dweb-browser/zstd-wasm/zstd_wasm_bg.wasm?url";

init(zstd_wasm_url).then(() => {
  /// compress or decompress
  const output = compress(new Uint8Array(100), 10);
  const input = decompress(output);
  console.log(input, output);
});

The above method uses fetch to download the wasm file. If you don't want to use a network request, you can also directly import the binary, which is stored in base64 within a JS file. The final bundle size will be larger as a result.

import { compress, decompress, initSync } from "@dweb-browser/zstd-wasm";
import get_zstd_wasm_binary from "@dweb-browser/zstd-wasm/zstd_wasm_bg_wasm.ts";
initSync(get_zstd_wasm_binary());

/// compress or decompress

how to use in nodejs

import fs from "node:fs";
import url from "node:url";
import { compress, decompress, initSync } from "@dweb-browser/zstd-wasm";
const zstd_wasm_binary = fs.readFileSync(
  url.fileURLToPath(
    import.meta.resolve("@dweb-browser/zstd-wasm/zstd_wasm_bg.wasm")
  )
);

initSync(zstd_wasm_binary);

/// compress or decompress

how to use in deno

import { compress, decompress, initSync } from "@dweb-browser/zstd-wasm";
import zstd_wasm_binary from "@dweb-browser/zstd-wasm/zstd_wasm_bg_wasm.ts";
initSync(get_zstd_wasm_binary());

/// compress or decompress
const output = compress(new Uint8Array(100), 10);
const input = decompress(output);
console.log(input, output);

how to build

1. read https://github.com/gyscos/zstd-rs/wiki/Compile-for-WASM
2. install wasm-bindgen cargo install wasm-bindgen-cli
3. install wasm-pack cargo install wasm-pack
4. install deno

   curl -fsSL https://deno.land/install.sh | sh # macos or linux
   irm https://deno.land/install.ps1 | iex # windows

5. run script: deno task build

   output to pkg folder