wxt-dev/wxt

[FEAT] support watch meta change in storage

Open

#1988 opened on Dec 8, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (9,861 stars) (511 forks)user submission
contribution welcomegood first issue

Description

Feature Request

Now we only support to watch the value of the local storage. But can't watch the change of the metadata of local storage variable.

What are the alternatives?

Now we have to add $ at the end of the KEY local:someKey$ to watch its metadata. But in the future, the underline implementation of the meta may change, and may should not add $.

This is the work around of my code

  // Add $ to the key to get the meta key for LAST_SYNCED_CONFIG_STORAGE_KEY
  const metaKey = `local:${LAST_SYNCED_CONFIG_STORAGE_KEY}$`

  const unwatch = storage.watch<LastSyncedConfigMeta>(metaKey, (_, newMeta) => {
    const meta = newMeta
    setAtom(meta?.lastSyncedAt ?? null)
  })

Additional context

Add any other context or screenshots about the feature request here.

Contributor guide

Tech stack
typescript
Domain
backenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
TypeScriptknowledge of browser storage APIfamiliarity with WXT framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The current workaround uses a '$' suffix on the key to watch metadata. The issue requests native support for watching metadata changes without relying on implementation details. Investigate the storage module in the codebase (likely src/storage or similar) to understand how watch currently works. Consider adding a watchMeta method or extending the watch function to accept a meta flag. Review any existing discussions or maintainer comments on the issue for preferred approach.