API / wxt/utils/storage / WxtStorage

Interface: WxtStorage

Source: packages/storage/dist/index.d.mts:5

Contents

• Methods
  • clear()
  • defineItem()
  • getItem()
  • getItems()
  • getMeta()
  • getMetas()
  • removeItem()
  • removeItems()
  • removeMeta()
  • restoreSnapshot()
  • setItem()
  • setItems()
  • setMeta()
  • setMetas()
  • snapshot()
  • unwatch()
  • watch()
  • watchMeta()

Methods

clear()

clear(base): Promise<void>

Source: packages/storage/dist/index.d.mts:109

Removes all items from the provided storage area.

Parameters

base

StorageArea

Returns

Promise<void>

---

defineItem()

Call Signature

defineItem<TValue, TMetadata>(key): WxtStorageItem<TValue | null, TMetadata>

Source: packages/storage/dist/index.d.mts:140

Define a storage item with a default value, type, or versioning.

Read full docs: https://wxt.dev/storage.html#defining-storage-items

Type Parameters

TValue

TValue

TMetadata

TMetadata extends Record<string, unknown> = { }

Parameters

key

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

Returns

WxtStorageItem<TValue | null, TMetadata>

Call Signature

defineItem<TValue, TMetadata>(key, options): WxtStorageItem<TValue, TMetadata>

Source: packages/storage/dist/index.d.mts:141

Type Parameters

TValue

TValue

TMetadata

TMetadata extends Record<string, unknown> = { }

Parameters

key

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

options

WxtStorageItemOptions<TValue> & object

Returns

WxtStorageItem<TValue, TMetadata>

Call Signature

defineItem<TValue, TMetadata>(key, options): WxtStorageItem<TValue, TMetadata>

Source: packages/storage/dist/index.d.mts:144

Type Parameters

TValue

TValue

TMetadata

TMetadata extends Record<string, unknown> = { }

Parameters

key

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

options

WxtStorageItemOptions<TValue> & object

Returns

WxtStorageItem<TValue, TMetadata>

Call Signature

defineItem<TValue, TMetadata>(key, options): WxtStorageItem<TValue, TMetadata>

Source: packages/storage/dist/index.d.mts:147

Type Parameters

TValue

TValue

TMetadata

TMetadata extends Record<string, unknown> = { }

Parameters

key

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

options

WxtStorageItemOptions<TValue> & object

Returns

WxtStorageItem<TValue, TMetadata>

Call Signature

defineItem<TValue, TMetadata>(key, options): WxtStorageItem<TValue | null, TMetadata>

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

Type Parameters

TValue

TValue

TMetadata

TMetadata extends Record<string, unknown> = { }

Parameters

key

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

options

WxtStorageItemOptions<TValue>

Returns

WxtStorageItem<TValue | null, TMetadata>

---

getItem()

Call Signature

getItem<TValue>(key, opts): Promise<TValue>

Source: packages/storage/dist/index.d.mts:12

Get an item from storage, or return null if it doesn't exist.

Type Parameters

TValue

TValue

Parameters

key

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

opts

GetItemOptions<TValue> & object

Returns

Promise<TValue>

Example

await storage.getItem<number>('local:installDate');

Call Signature

getItem<TValue>(key, opts?): Promise<TValue | null>

Source: packages/storage/dist/index.d.mts:15

Type Parameters

TValue

TValue

Parameters

key

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

opts?

GetItemOptions<TValue>

Returns

Promise<TValue | null>

---

getItems()

getItems(keys): Promise<object[]>

Source: packages/storage/dist/index.d.mts:23

Get multiple items from storage. The return order is guaranteed to be the same as the order requested.

Parameters

keys

(`local:${string}` | `session:${string}` | `sync:${string}` | `managed:${string}` | WxtStorageItem<any, any> | { key: `local:${string}` | `session:${string}` | `sync:${string}` | `managed:${string}`; options?: GetItemOptions<any>; })[]

Returns

Promise<object[]>

Example

await storage.getItems(['local:installDate', 'session:someCounter']);

---

getMeta()

getMeta<T>(key): Promise<T>

Source: packages/storage/dist/index.d.mts:37

Return an object containing metadata about the key. Object is stored at key + "$". If value is not an object, it returns an empty object.

Type Parameters

T

T extends Record<string, unknown>

Parameters

key

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

Returns

Promise<T>

Example

await storage.getMeta('local:installDate');

---

getMetas()

getMetas(keys): Promise<object[]>

Source: packages/storage/dist/index.d.mts:44

Get the metadata of multiple storage items.

Parameters

keys

(`local:${string}` | `session:${string}` | `sync:${string}` | `managed:${string}` | WxtStorageItem<any, any>)[]

List of keys or items to get the metadata of.

Returns

Promise<object[]>

An array containing storage keys and their metadata.

---

removeItem()

removeItem(key, opts?): Promise<void>

Source: packages/storage/dist/index.d.mts:99

Removes an item from storage.

Parameters

key

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

opts?

RemoveItemOptions

Returns

Promise<void>

Example

await storage.removeItem('local:installDate');

---

removeItems()

removeItems(keys): Promise<void>

Source: packages/storage/dist/index.d.mts:101

Remove a list of keys from storage.

Parameters

keys

(`local:${string}` | `session:${string}` | `sync:${string}` | `managed:${string}` | WxtStorageItem<any, any> | { key: `local:${string}` | `session:${string}` | `sync:${string}` | `managed:${string}`; options?: RemoveItemOptions; } | { item: WxtStorageItem<any, any>; options?: RemoveItemOptions; })[]

Returns

Promise<void>

---

removeMeta()

removeMeta(key, properties?): Promise<void>

Source: packages/storage/dist/index.d.mts:120

Remove the entire metadata for a key, or specific properties by name.

Parameters

key

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

properties?

string | string[]

Returns

Promise<void>

Example

// Remove all metadata properties from the item
  await storage.removeMeta('local:installDate');

  // Remove only specific the "v" field
  await storage.removeMeta('local:installDate', 'v');

---

restoreSnapshot()

restoreSnapshot(base, data): Promise<void>

Source: packages/storage/dist/index.d.mts:128

Restores the results of snapshot. If new properties have been saved since the snapshot, they are not overridden. Only values existing in the snapshot are overridden.

Parameters

base

StorageArea

data

any

Returns

Promise<void>

---

setItem()

setItem<T>(key, value): Promise<void>

Source: packages/storage/dist/index.d.mts:55

Set a value in storage. Setting a value to null or undefined is equivalent to calling removeItem.

Type Parameters

T

T

Parameters

key

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

value

T | null

Returns

Promise<void>

Example

await storage.setItem<number>('local:installDate', Date.now());

---

setItems()

setItems(values): Promise<void>

Source: packages/storage/dist/index.d.mts:66

Set multiple values in storage. If a value is set to null or undefined, the key is removed.

Parameters

values

({ key: `local:${string}` | `session:${string}` | `sync:${string}` | `managed:${string}`; value: any; } | { item: WxtStorageItem<any, any>; value: any; })[]

Returns

Promise<void>

Example

await storage.setItem([
  { key: "local:installDate", value: Date.now() },
  { key: "session:someCounter, value: 5 },
  ]);

---

setMeta()

setMeta<T>(key, properties): Promise<void>

Source: packages/storage/dist/index.d.mts:80

Sets metadata properties. If some properties are already set, but are not included in the properties parameter, they will not be removed.

Type Parameters

T

T extends Record<string, unknown>

Parameters

key

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

properties

T | null

Returns

Promise<void>

Example

await storage.setMeta('local:installDate', { appVersion });

---

setMetas()

setMetas(metas): Promise<void>

Source: packages/storage/dist/index.d.mts:86

Set the metadata of multiple storage items.

Parameters

metas

({ key: `local:${string}` | `session:${string}` | `sync:${string}` | `managed:${string}`; meta: Record<string, any>; } | { item: WxtStorageItem<any, any>; meta: Record<string, any>; })[]

List of storage keys or items and metadata to set for each.

Returns

Promise<void>

---

snapshot()

snapshot(base, opts?): Promise<Record<string, unknown>>

Source: packages/storage/dist/index.d.mts:122

Return all the items in storage.

Parameters

base

StorageArea

opts?

SnapshotOptions

Returns

Promise<Record<string, unknown>>

---

unwatch()

unwatch(): void

Source: packages/storage/dist/index.d.mts:134

Remove all watch listeners.

Returns

void

---

watch()

watch<T>(key, cb): Unwatch

Source: packages/storage/dist/index.d.mts:130

Watch for changes to a specific key in storage.

Type Parameters

T

T

Parameters

key

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

cb

WatchCallback<T | null>

Returns

Unwatch

---

watchMeta()

watchMeta<T>(key, cb): Unwatch

Source: packages/storage/dist/index.d.mts:132

Watch for changes to a specific key's metadata in storage.

Type Parameters

T

T extends Record<string, unknown>

Parameters

key

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

cb

WatchCallback<T>

Returns

Unwatch

---

Generated using typedoc-plugin-markdown and TypeDoc