solidjs-community/solid-primitives

`captureStoreUpdates` — return the full `path` to the property that changed

Open

#576 opened on Feb 28, 2024

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)TypeScript (153 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (1,541 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe The Problem To Be Solved

I'm migrating from on-change to using captureStoreUpdates().

When using captureStoreUpdates(), setting a new value mutable.settings.model = model will produce the path: ["settings"]. However, if I replace the entire settings object this will trigger more updates than just updating the settings.model property.

Suggest A Solution

I propose for an option or change in behavior where setting mutable.settings.model produces path: ["settings", "model"].

Contributor guide

Research direction
Examine the current implementation of captureStoreUpdates to understand how paths are generated. Look at the proxy handler and how property access is tracked. Then modify it to capture the full path by storing nested property names as they are accessed.
Tech stack
typescript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
SolidJSTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70