Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.6 KB

File metadata and controls

46 lines (34 loc) · 2.6 KB

@stainless-code/persist

Any store, any storage, one middleware — no flash.

Hydration-aware persistence for any reactive store — no hydrate flash, no SSR mismatch. Store-agnostic via a structural PersistableSource (TanStack Store, zustand, jotai, valtio, mobx, pinia, redux, or a hand-rolled atom); three composable seams (backend × codec × source) so you swap storage, serialization, or framework without rewriting. A first-class hydration signal gates UI on async backends; opt-in cross-tab sync, versioned migrations, encrypted/compressed backends, and retry-on-quota. Framework adapters for React, Preact, Solid, Angular, Vue, Lit, Alpine, and Svelte.

bundle size

Docs: https://stainless-code.com/persist

Install

bun add @stainless-code/persist

Quick start

import { Store } from "@tanstack/store";
import { createSerovalStorage } from "@stainless-code/persist/codecs/seroval";
import { persistStore } from "@stainless-code/persist/sources/tanstack-store";
import { toHydrationSignal } from "@stainless-code/persist";
import { useHydrated } from "@stainless-code/persist/frameworks/react";

const store = new Store({ theme: "light" });
const persist = persistStore(store, {
  name: "app:prefs:v1",
  storage: createSerovalStorage(() => localStorage),
});
export const prefsHydration = toHydrationSignal(persist);

// in a component:
const { hydrated } = useHydrated(prefsHydration);

Documentation

Getting started Install, peers, quick start
Guides Hydration, IndexedDB + React, migrations, FAQ
Recipes Encrypt, options, wrapping stores, cross-tab
Concepts Three seams, storage/codec choice, entry points
Reference Generated API (TypeDoc)
Changelog GitHub Releases