useStorage API

API reference for the useStorage composable.

Explore these related pages for additional context and usage patterns.

(options?: StorageOptions) => E

Creates a new storage instance.

<_E>(_options?: StorageContextOptions | undefined) => ContextTrinity<_E>

(_options?: StorageContextOptions | undefined) => Plugin

<_E>(namespace?: string) => _E

StorageAdapter | undefined

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

string | undefined

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

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

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

number | undefined

Time-to-live in milliseconds. When set, expired entries return the default value on `get()` and `set()` automatically timestamps entries.

(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