wxt-dev/wxt

Single watcher for multiple keys

Open

#999 opened on Sep 27, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)TypeScript (511 forks)user submission
contribution welcomegood first issue

Repository metrics

Stars
 (9,861 stars)
PR merge metrics
 (Avg merge 11h 6m) (11 merged PRs in 30d)

Description

Feature Request

This snippet allows for watching a single item: https://github.com/wxt-dev/wxt/blob/c0aa12089e24c9f0cb01fb3f8546f17096b21341/packages/wxt/src/storage.ts#L434-L447

I also wish to have a watcher setup like this:

const unwatch = storage.watch({
  "local:item1"((newValue, oldValue) => {...}),
  "local:item2"((newValue, oldValue) => {...})
});
unwatch();

Is your feature request related to a bug?

N/A

What are the alternatives?

storage.watch("local:item1", (newValue, oldValue) => {...});
storage.watch("local:item2", (newValue, oldValue) => {...});

Additional context

This functionality is available in Plasmo

Contributor guide

Research direction
Examine the existing watch implementation in packages/wxt/src/storage.ts (line 434-447) to understand how single key watching works. Extend the function to accept an object with key callback pairs, iterating over each key to register the watchers and return a combined unwatch function. Consider similar functionality in Plasmo's storage watch for inspiration, and ensure backward compatibility with the current single key signature.
Tech stack
typescript
Domain
developer experienceapi
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.
1-3 hours
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.
Clear
Prerequisites
TypeScriptUnderstanding of wxt storage API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80