API > wxt/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/wxt/src/storage.ts:598
fallback
fallback:
TValue
The value provided by the fallback option.
Source
packages/wxt/src/storage.ts:602
Methods
getMeta()
getMeta():
Promise<NullablePartial<TMetadata>>
Get metadata.
Source
packages/wxt/src/storage.ts:610
getValue()
getValue():
Promise<TValue>
Get the latest value from storage.
Source
packages/wxt/src/storage.ts:606
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/wxt/src/storage.ts:637
removeMeta()
removeMeta(
properties?):Promise<void>
Remove all metadata or certain properties from metadata.
Parameters
▪ properties?: string[]
Source
packages/wxt/src/storage.ts:626
removeValue()
removeValue(
opts?):Promise<void>
Remove the value from storage.
Parameters
▪ opts?: RemoveItemOptions
Source
packages/wxt/src/storage.ts:622
setMeta()
setMeta(
properties):Promise<void>
Set metadata properties.
Parameters
▪ properties: NullablePartial<TMetadata>
Source
packages/wxt/src/storage.ts:618
setValue()
setValue(
value):Promise<void>
Set the value in storage.
Parameters
▪ value: TValue
Source
packages/wxt/src/storage.ts:614
watch()
watch(
cb):Unwatch
Listen for changes to the value in storage.
Parameters
▪ cb: WatchCallback<TValue>
Source
packages/wxt/src/storage.ts:630
Generated using typedoc-plugin-markdown and TypeDoc