Skip to main content
Guide
The forthcoming v3 TypeScript SDK targets Node.js 20 or newer and emits the same operation-tree AST as the v3 Rust, Go, and Python SDKs.
The v3 SDK packages have not been published yet. The package names and installation commands on this page describe the upcoming v3 release.

Install

The package is ESM. Set "type": "module" or compile to ESM.

Define a query

Execute

Use withApiKey("hx_...") for Helix Cloud.

Integer safety

The SDK preserves 64-bit integers as bigint. Use stringifyJson or the request’s serialization methods instead of JSON.stringify when a value can contain bigint.

Embedded runtime

Install the SDK and embedded runtime with npm install @helix-db/helix-db@3.0.0 @helix-db/uniffi. See Embedded database for storage, cache, and handle configuration.

Verify

Next steps

Query tutorial

Build reads, writes, and parameters.

Embedded database

Open HelixDB directly inside your process.