Install the TypeScript SDK

Prerequisites

Node 20 or newer. A package manager (npm, pnpm, or yarn). A bundler with WASM support if targeting the browser (Vite, Rollup, esbuild, webpack 5+).

Install

npm install @panproto/core
# or
pnpm add @panproto/core
# or
yarn add @panproto/core

Verification

import { Panproto } from '@panproto/core';

const p = await Panproto.init();
console.log(p.listProtocols());

Panproto.init() loads the WASM module and returns the top-level handle. Calling p.listProtocols() enumerates the built-in protocols and confirms the binding is wired up.

Common mistakes

• Forgetting to await Panproto.init(). The WASM load is asynchronous; using the handle before init resolves throws.
• Using a bundler without WebAssembly asset support. Configure the bundler to copy and load the package’s .wasm asset.
• Running under Node earlier than 20. The package metadata requires Node 20 or later.

See also

• Reference: TypeScript SDK.
• Define a schema from TypeScript.
• Tutorial: your first schema.