Skip to content

BrowserPersistence

IndexedDB-backed persistence layers for browser Effect programs.

This module provides a low-level BackingPersistence layer and a higher-level Persistence layer that store object values in IndexedDB. Values are stored by persistence store id and key, and reads check TTL expiration before returning stored data. The database name can be customized and defaults to "effect_persistence".

2 exports Added in v4.0.0 Source

Layers

layerBackingIndexedDb

Added in v4.0.0 Source

Creates a BackingPersistence layer backed by IndexedDB, optionally using the provided database name.

When to use

Use when composing persistence manually and the lower-level BackingPersistence service should be backed by browser IndexedDB.

Details

The database name defaults to "effect_persistence". Entries are stored by persistence store id and key in a shared object store, and TTL expiration is checked when values are read.

Gotchas

Opening the database is defected during layer acquisition if IndexedDB is unavailable or cannot be opened. Store operations report PersistenceError for IndexedDB request, transaction, quota, and structured-clone failures.

See

Signature

declare function layerBackingIndexedDb(options?: {
  readonly database?: string;
}): Layer<BackingPersistence>;

layerIndexedDb

Added in v4.0.0 Source

Creates a Persistence layer backed by IndexedDB, optionally using the provided database name.

Signature

declare function layerIndexedDb(options?: { readonly database?: string }): Layer<Persistence>;