WXT

Appearance

API > wxt/storage > WxtStorageItem

Interface: WxtStorageItem<TValue, TMetadata> ​

Contents ​

Type parameters ​

▪ TValue

▪ TMetadata extends Record<string, unknown>

Properties ​

defaultValue ​

defaultValue: TValue

Source ​

src/storage.ts:545

Methods ​

getMeta() ​

getMeta(): Promise<NullablePartial<TMetadata>>

Get metadata.

Source ​

src/storage.ts:553

getValue() ​

getValue(): Promise<TValue>

Get the latest value from storage.

Source ​

src/storage.ts:549

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 ​

src/storage.ts:580

removeMeta() ​

removeMeta(properties?): Promise<void>

Remove all metadata or certain properties from metadata.

Parameters ​

▪ properties?: string[]

Source ​

src/storage.ts:569

removeValue() ​

removeValue(opts?): Promise<void>

Remove the value from storage.

Parameters ​

▪ opts?: RemoveItemOptions

Source ​

src/storage.ts:565

setMeta() ​

setMeta(properties): Promise<void>

Set metadata properties.

Parameters ​

▪ properties: NullablePartial<TMetadata>

Source ​

src/storage.ts:561

setValue() ​

setValue(value): Promise<void>

Set the value in storage.

Parameters ​

▪ value: TValue

Source ​

src/storage.ts:557

watch() ​

watch(cb): Unwatch

Listen for changes to the value in storage.

Parameters ​

▪ cb: WatchCallback<TValue>

Source ​

src/storage.ts:573

Generated using typedoc-plugin-markdown and TypeDoc