react18-tools/persist-and-sync

Throw Error when store name is changed.

Open

#11 opened on Dec 30, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (9 forks)auto 404
good first issue

Repository metrics

Stars
 (48 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. The name of the persistent store can not be changed, as it is used before the state is loaded.

Describe the solution you'd like

  1. Create an interface for __persistNSyncOptions. This interface should not include name.
  2. Throw an error when name is changed.
  3. Always read option.name and not prevState.__persistNSyncOptions.name

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

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

Contributor guide

Research direction
Examine the existing persistNSyncOptions interface and the code where name is used before state loading. Create a new interface excluding name, then add a check to throw an error when name changes. Also ensure option.name is always read instead of prevState. persistNSyncOptions.name.
Tech stack
typescriptreact
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
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75