#Class: OpfsSahEnvironment

OPFS SAH‑pool environment implemented with a Dedicated Worker.

Spawns a Worker and forwards calls via a minimal RPC while keeping the environment async surface. Use one instance per logical database key.

#Example

// Static helper: clear all OPFS data for this origin (destructive)
await OpfsSahEnvironment.clear()

#Implements

• LixEnvironment

#Constructors

#Constructor

new OpfsSahEnvironment(opts?: { key?: string; }): OpfsSahEnvironment

#Parameters

#Returns

OpfsSahEnvironment

#Methods

#call()

call(name: string, args?: unknown): Promise<unknown>

Invoke a named engine function inside the worker engine.

#Parameters

#Returns

Promise<unknown>

#Implementation of

LixEnvironment.call

#close()

close(): Promise<void>

#Returns

Promise<void>

#Implementation of

LixEnvironment.close

#create()

create(createOpts: { blob: ArrayBuffer; }): Promise<void>

#Parameters

#Returns

Promise<void>

#Implementation of

LixEnvironment.create

#exists()

exists(): Promise<boolean>

#Returns

Promise<boolean>

#Implementation of

LixEnvironment.exists

#export()

export(): Promise<ArrayBuffer>

Export the SQLite database image as raw bytes.

Worker returns one of two shapes for performance:

• Fast path: { blob: ArrayBuffer } (zero‑copy transfer)
• Fallback: { buffer, offset, length } (single copy on host)

#Returns

Promise<ArrayBuffer>

#Implementation of

LixEnvironment.export

#open()

open(initOpts: { boot: { args: BootArgs; }; emit: (ev: EngineEvent) => void; }): Promise<{ engine?: LixEngine; }>

#Parameters

#Returns

Promise<{ engine?: LixEngine; }>

#Implementation of

LixEnvironment.open

#spawnActor()

spawnActor(opts: SpawnActorOptions): Promise<EnvironmentActorHandle>

Spawn a dedicated worker-based actor.

Messages emitted by the worker before any subscribers attach are buffered and replayed to the first subscriber so initialization events are never lost.

#Example

const actor = await env.spawnActor({ entryModule, name: "echo" });
const unsubscribe = actor.subscribe((message) => console.log(message));
actor.post({ type: "ping" });

#Parameters

#Returns

Promise<EnvironmentActorHandle>

#Implementation of

LixEnvironment.spawnActor

#clear()

static clear(): Promise<void>

Cleans the entire OPFS by removing all files. Useful for debugging and testing.

WARNING! This will delete ALL files in OPFS, not just Lix files!

#Returns

Promise<void>