Skip to content

API > @wxt-dev/storage > WxtStorageItem

Interface: WxtStorageItem<TValue, TMetadata>

Contents

Type parameters

TValue

TMetadata extends Record<string, unknown>

Properties

defaultValue

defaultValue: TValue

Deprecated

Renamed to fallback, use it instead.

Source

packages/storage/dist/index.d.mts:150


fallback

fallback: TValue

The value provided by the fallback option.

Source

packages/storage/dist/index.d.mts:154


key

key: `local:${string}` | `sync:${string}` | `managed:${string}` | `session:${string}`

The storage key passed when creating the storage item.

Source

packages/storage/dist/index.d.mts:146

Methods

getMeta()

getMeta(): Promise<NullablePartial<TMetadata>>

Get metadata.

Source

packages/storage/dist/index.d.mts:162


getValue()

getValue(): Promise<TValue>

Get the latest value from storage.

Source

packages/storage/dist/index.d.mts:158


migrate()

migrate(): Promise<void>

If there are migrations defined on the storage item, migrate to the latest version.

This function is ran automatically whenever the extension updates, so you don't have to call it manually.

Source

packages/storage/dist/index.d.mts:189


removeMeta()

removeMeta(properties?): Promise<void>

Remove all metadata or certain properties from metadata.

Parameters

properties?: string[]

Source

packages/storage/dist/index.d.mts:178


removeValue()

removeValue(opts?): Promise<void>

Remove the value from storage.

Parameters

opts?: RemoveItemOptions

Source

packages/storage/dist/index.d.mts:174


setMeta()

setMeta(properties): Promise<void>

Set metadata properties.

Parameters

properties: NullablePartial<TMetadata>

Source

packages/storage/dist/index.d.mts:170


setValue()

setValue(value): Promise<void>

Set the value in storage.

Parameters

value: TValue

Source

packages/storage/dist/index.d.mts:166


watch()

watch(cb): Unwatch

Listen for changes to the value in storage.

Parameters

cb: WatchCallback<TValue>

Source

packages/storage/dist/index.d.mts:182


Generated using typedoc-plugin-markdown and TypeDoc