useStorageAsync

v0.0.12testeddemo

Reactive Storage binding with async support — creates a ref synced with an async storage backend

Examples

const { state } = useStorageAsync('access-token', '', asyncStorage);

const { state, isReady } = await useStorageAsync('settings', { theme: 'dark' }, asyncStorage);

const { state } = useStorageAsync('key', 'default', asyncStorage, {
  onReady: (value) => console.log('Loaded:', value),
});

Demo

Loading demo…

Signatures

export function useStorageAsync<T extends string, Shallow extends boolean = true>(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<T>, storage: StorageLikeAsync, options?: UseStorageAsyncOptions<T, Shallow>): UseStorageAsyncReturn<T, Shallow>;

export function useStorageAsync<T extends number, Shallow extends boolean = true>(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<T>, storage: StorageLikeAsync, options?: UseStorageAsyncOptions<T, Shallow>): UseStorageAsyncReturn<T, Shallow>;

export function useStorageAsync<T extends boolean, Shallow extends boolean = true>(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<T>, storage: StorageLikeAsync, options?: UseStorageAsyncOptions<T, Shallow>): UseStorageAsyncReturn<T, Shallow>;

export function useStorageAsync<T, Shallow extends boolean = true>(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<T>, storage: StorageLikeAsync, options?: UseStorageAsyncOptions<T, Shallow>): UseStorageAsyncReturn<T, Shallow>;

export function useStorageAsync<T = unknown, Shallow extends boolean = true>(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<null>, storage: StorageLikeAsync, options?: UseStorageAsyncOptions<T, Shallow>): UseStorageAsyncReturn<T, Shallow>;

Type Parameters

T

Shallowextends boolean= true

Parameters

Parameter	Type	Default	Description
`key`	`MaybeRefOrGetter<string>`	—	The storage key (can be reactive)
`initialValue`	`MaybeRefOrGetter<T>`	—	The initial/default value
`storage`	`StorageLikeAsync`	—	The storage key (can be reactive)
`options`?	`UseStorageAsyncOptions<T, Shallow>`	`{}`	Options

Returns

UseStorageAsyncReturn<T, Shallow>An object with state ref and isReady flag, also awaitable