API

The Essentials

• create
• exec
• query
• sql
• transaction

tinyjoin

The tinyjoin module provides a small PostgreSQL-shaped relational database that runs in a dedicated browser Worker and stores data in memory or OPFS. Read more.

• Classes
• Interfaces
• create function
• Type Aliases

node

The node module opens ephemeral TinyJoin databases in Node.js 22 or later. It constructs a Node Worker thread and loads the packaged WebAssembly engine automatically, with no extra dependencies, bundler, or polyfills. Read more.

• create function
• References

worker

The worker module lets advanced applications start TinyJoin inside a Worker that they construct and bundle themselves. Read more.

• startWorker

drizzle

The drizzle module connects the Drizzle ORM query builder to a TinyJoin Client. It needs drizzle-orm 0.45 or later, which the application installs itself: TinyJoin declares it as an optional peer dependency and never bundles it. Read more.

• drizzle function
• TinyJoinDatabase type alias

vite

The vite module provides optional production offline caching for Vite applications, including TinyJoin's lazily loaded Worker, OPFS, and WASM files. This Node-only build integration is separate from the browser runtime. Read more.

• TinyjoinOfflineOptions interface
• tinyjoinOffline function