@gluonjs/store / packages/store/src / createAsyncPersistencePlugin
Function: createAsyncPersistencePlugin()
createAsyncPersistencePlugin(
options):AsyncPersistencePlugin
Creates an application-local async persistence plugin. use() is synchronous:
stores expose their defaults while the lifecycle is hydrating; callers that
need restored state await plugin.lifecycle.ready before starting rendering,
routing, or SSR hydration.
Parameters
options
Returns
Example
Bootstrap an application from promise-based Store persistence while awaiting its current hydration lifecycle:
import {
createAsyncPersistencePlugin,
createStoreManager,
defineStore,
type AsyncPersistenceLifecycle,
type AsyncPersistencePlugin,
type AsyncPersistencePluginOptions,
type AsyncPersistenceStatus,
type AsyncStorageLike,
type StoreAbortSignal,
} from '@gluonjs/store';
declare function indexedDbGet(key: string, signal?: StoreAbortSignal): Promise<string | null>;
declare function indexedDbSet(key: string, value: string, signal?: StoreAbortSignal): Promise<void>;
const storage: AsyncStorageLike = {
async getItem(key, signal) { return await indexedDbGet(key, signal); },
async setItem(key, value, signal) { await indexedDbSet(key, value, signal); },
};
const signal: StoreAbortSignal | undefined = undefined;
const pluginOptions: AsyncPersistencePluginOptions = { storage, signal };
const persistence: AsyncPersistencePlugin = createAsyncPersistencePlugin(pluginOptions);
const manager = createStoreManager({ plugins: [persistence] });
const cart = manager.use(defineStore({ id: 'cart', state: () => ({ items: [] as string[] }), persist: true }));
const lifecycle: AsyncPersistenceLifecycle = persistence.lifecycle;
const status: AsyncPersistenceStatus = lifecycle.status;
await lifecycle.ready;
if (lifecycle.status === 'ready') console.log('bootstrap restored store', cart.items);