useStorage API

API reference for the useStorage composable.

Options

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