Installation

bun add yieldstar

Node projects can install the same package with their package manager:

pnpm add yieldstar

For the resident-process runtime with SQLite persistence:

bun add @yieldstar/core @yieldstar/worker-invoker @yieldstar/sqlite-runtime pino

Import createSqliteDb from @yieldstar/sqlite-runtime/bun when using Bun or @yieldstar/sqlite-runtime/node when using Node 22.6 or newer with TypeScript workers.

To expose that runtime over HTTP, also install:

bun add @yieldstar/http-server

Version 0.5 replaced the old @yieldstar/bun-sqlite-runtime, @yieldstar/bun-worker-invoker, and @yieldstar/bun-http-server packages with the runtime-neutral packages above. Choose the /bun or /node SQLite connector only when importing createSqliteDb.

See the runtime matrix for supported runtime families and connector combinations.