useStorage API

API reference for the useStorage composable.

Functions

(options?: StorageOptions) => E

Creates a new storage instance.

(_options?: StorageContextOptions) => ContextTrinity<E>

(_options?: StoragePluginOptions) => any

Creates a new storage plugin.

(namespace?: string) => E

Returns the current storage instance.

StorageAdapter

The storage adapter to use. Defaults to localStorage in browser, MemoryAdapter otherwise

string

The prefix to use for all storage keys. Defaults to 'v0:'

{ read: (value: string) => unknown; write: (value: unknown) => string; }

Custom serializer for reading and writing values. Defaults to JSON.parse/stringify

(key: string) => boolean

Check if a key exists in storage

<T>(key: string, defaultValue?: T) => Ref<T>

Get a reactive ref for a storage key

<T>(key: string, value: T) => void

Set a value for a storage key

(key: string) => void

Remove a key from storage

() => void

Clear all keys from storage