Start

Install

GitHub Edit page

Install

libopus-wasm ships precompiled WebAssembly. Installing it pulls no native toolchain and runs no build step — the .wasm is inlined into the published JavaScript.

#Add the package

npm install libopus-wasm
# or
pnpm add libopus-wasm
# or
yarn add libopus-wasm

#Requirements

  • Node: 20 or newer. The package is ESM-only ("type": "module").
  • Browsers: any engine with WebAssembly and ES2022 — every current

    • evergreen browser qualifies.

  • No cross-origin isolation. The module is single-threaded and needs neither

    • SharedArrayBuffer nor COOP/COEP headers.

#Entry points

ImportRuntimeUse it for
libopus-wasmBrowser + NodeThe full encoder/decoder API. Browser-safe.
libopus-wasm/discordjsNode onlyA drop-in for @discordjs/opus. Uses Buffer.
import { createEncoder, createDecoder } from "libopus-wasm";
import { OpusEncoder } from "libopus-wasm/discordjs";

The main entry is browser-safe and self-contained. The discordjs adapter imports node:buffer, so it is Node-only by design — see discord.js compatibility.

#Module format

The package is pure ESM with bundled TypeScript declarations:

{
  "exports": {
    ".": { "types": "./dist/index.d.ts", "browser": "./dist/index.js", "import": "./dist/index.js" },
    "./discordjs": { "types": "./dist/discordjs.d.ts", "import": "./dist/discordjs.js" }
  }
}

To consume it from CommonJS, use a dynamic import():

const { createEncoder } = await import("libopus-wasm");

#TypeScript

Types ship in the package; no @types/* install is needed. The structural handle types are exported as OpusEncoderHandle and OpusDecoderHandle, and all enums (Application, Signal, Bitrate, Bandwidth, EncoderCtl, DecoderCtl) are exported as both values and types.

#Building from source

The npm package is all you need to use the codec. If you want to compile libopus yourself — to pin a different version or audit the toolchain — see Building from source. It requires Emscripten (emcc) on PATH.

#Next