Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docs on state_unsafe_mutation error #14932

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dummdidumm
Copy link
Member

closes #14752

Copy link

changeset-bot bot commented Jan 7, 2025

⚠️ No Changeset found

Latest commit: 77434b2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-svelte-14932-svelte.vercel.app/

this is an automated message

Copy link
Contributor

github-actions bot commented Jan 7, 2025

Playground

pnpm add https://pkg.pr.new/svelte@14932

@Rich-Harris
Copy link
Member

I think it would be helpful to use an example where the mutated state is independent of the derived — it's easy to look at the current example and think 'well of course you can't update the thing the result depends on', when actually it's nothing to do with the cyclicality.

I'd guess that most people are encountering a non-cyclical version of this problem (i.e. treating the derived as a convenient place to update some independent state). Ideally the example would reflect real cases — @MathiasWP do you recall what sort of things led to you encountering this error?

@MathiasWP
Copy link
Contributor

I think it would be helpful to use an example where the mutated state is independent of the derived — it's easy to look at the current example and think 'well of course you can't update the thing the result depends on', when actually it's nothing to do with the cyclicality.

I'd guess that most people are encountering a non-cyclical version of this problem (i.e. treating the derived as a convenient place to update some independent state). Ideally the example would reflect real cases — @MathiasWP do you recall what sort of things led to you encountering this error?

I've gone on a scavenge hunt to try and find the code that caused this, but with no luck (it was quite difficult to find in the first place when it happened) :/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Client errors aren't that helpful in the docs
3 participants