WXT

Appearance

API > wxt/storage > WxtStorageItem

Interface: WxtStorageItem<TValue, TMetadata> ​

Contents ​

Type parameters ​

▪ TValue

▪ TMetadata extends Record<string, unknown>

Properties ​

defaultValue ​

defaultValue: TValue

Source ​

packages/wxt/src/storage.ts:565

Methods ​

getMeta() ​

getMeta(): Promise<NullablePartial<TMetadata>>

Get metadata.

Source ​

packages/wxt/src/storage.ts:573

getValue() ​

getValue(): Promise<TValue>

Get the latest value from storage.

Source ​

packages/wxt/src/storage.ts:569

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:600

removeMeta() ​

removeMeta(properties?): Promise<void>

Remove all metadata or certain properties from metadata.

Parameters ​

▪ properties?: string[]

Source ​

packages/wxt/src/storage.ts:589

removeValue() ​

removeValue(opts?): Promise<void>

Remove the value from storage.

Parameters ​

▪ opts?: RemoveItemOptions

Source ​

packages/wxt/src/storage.ts:585

setMeta() ​

setMeta(properties): Promise<void>

Set metadata properties.

Parameters ​

▪ properties: NullablePartial<TMetadata>

Source ​

packages/wxt/src/storage.ts:581

setValue() ​

setValue(value): Promise<void>

Set the value in storage.

Parameters ​

▪ value: TValue

Source ​

packages/wxt/src/storage.ts:577

watch() ​

watch(cb): Unwatch

Listen for changes to the value in storage.

Parameters ​

▪ cb: WatchCallback<TValue>

Source ​

packages/wxt/src/storage.ts:593

Generated using typedoc-plugin-markdown and TypeDoc