Skip to content

Public API reference

This is the hub for the public exports from src/lib/index.ts. If you want the "what does this do and when should I use it?" version, use the topic pages below instead of treating this page like a raw export list.

Start here

TopicWhat it coversBest for
Core runtimedefineStore, state managers, store helpers, Svelte interop, and external subscribersUnderstanding the store lifecycle and the core API surface
Plugins and orchestrationPersistence, history, sync, and async pluginsLearning how the advanced features fit together
Persistence helpersStorage adapters, compression, and persistence typesBuilding or customizing durable store state
Public typesStore, manager, history, sync, and async type contractsAdding strong TypeScript inference or writing plugins

What this reference includes

The pages linked above cover every package-root export in src/lib/index.ts, including the store manager helpers, plugin factories, storage adapters, compression helpers, and public type definitions.

Read alongside the guide

The reference tells you exactly what each API does. For step-by-step usage, pair it with the guide and examples and recipes.

Released under the MIT License.