Menu
Persist with IndexedDB via @stainless-code/persist/backends/idb (createIdbStorage / idbStateStorage). Use for large or structured-clone state; pair with useHydrated and BroadcastChannel cross-tab.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | persist-idb |
| description | Persist with IndexedDB via @stainless-code/persist/backends/idb (createIdbStorage / idbStateStorage). Use for large or structured-clone state; pair with useHydrated and BroadcastChannel cross-tab. |
| license | MIT |
| metadata | {"type":"composition","library":"@stainless-code/persist","library_version":"0.4.1","framework":"idb-keyval"} |
| requires | ["persist"] |
| sources | ["stainless-code/persist:src/adapters/backends/idb.ts"] |
createIdbStorage uses structured clone + identityCodec — Set/Map/Date work without seroval. Fully async → gate UI. No storage events → use persist-crosstab for multi-tab.
bun add @stainless-code/persist idb-keyval
Peer: idb-keyval >=4.0.0.
import { createIdbStorage } from "@stainless-code/persist/backends/idb";
const storage = createIdbStorage<Prefs>();
Custom codec: createStorage(() => idbStateStorage(store), codec, opts). Encrypt wraps the backend, not the codec arg — createStorage(() => createEncryptedStorage(() => idbStateStorage(), { key })!, codec, opts) (see persist-encrypted).
clearCorruptOnFailure is inert on the default identity path (identity never throws).onError "hydrate"), not at construct.crossTab: true alone is useless on IDB — no storage events; use persist-crosstab (wrap + crossTabEventTarget).useHydrated.storage events.createIdbStorage(options?) · idbStateStorage(store?)See also: persist-crosstab; *-persist for UI gates.
Gate Alpine.js UI on Persist hydration (Alpine.plugin + useHydrated / $hydrated). Use when wiring HydrationSignal into Alpine data components.
Gate Angular UI on Persist hydration with useHydrated (readonly Signal). Call inside an injection context; use when avoiding flash of default state on async backends.
Gate Lit element UI on Persist hydration with HydrationController. Use when wiring HydrationSignal into a ReactiveControllerHost; not a hook.
Persist with React Native AsyncStorage via @stainless-code/persist/backends/async-storage. Use for RN string-wire JSON state; always gate with useHydrated.
Compress a string-wire StateStorage with @stainless-code/persist/backends/compressed (gzip/deflate). Backend wrapper — compose with createStorage; stack compress-then-encrypt.
Cross-tab sync for backends without storage events via @stainless-code/persist/transport/crosstab (createBroadcastCrossTab). Wrap storage + pass crossTabEventTarget; call close() on teardown.