Skip to content

feat: add $effect.allowed rune #16458

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

feat: add $effect.allowed rune #16458

wants to merge 13 commits into from

Conversation

Ocean-OS
Copy link
Member

@Ocean-OS Ocean-OS commented Jul 20, 2025

This adds the $effect.allowed rune, an advanced feature that indicates whether an effect or async derived can be created in the current context. Effects and async deriveds can only be created when a root effect is active, and previously, the only way to know this was to try creating an effect and checking if it threw an error.
Closes #16366.

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.
  • If this PR changes code within packages/svelte/src, add a changeset (npx changeset).

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

@svelte-docs-bot
Copy link

Copy link
Contributor

Playground

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

Copy link

changeset-bot bot commented Jul 20, 2025

🦋 Changeset detected

Latest commit: 5aff44a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
svelte Minor

Not sure what this means? Click here to learn what changesets are.

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

@7nik
Copy link
Contributor

7nik commented Jul 21, 2025

A bit of bikeshading: the name active_root_effect() confuses me. Also, I like Rich's $effect.allowed() name as more close to the rune's purpose.

@Ocean-OS
Copy link
Member Author

Yeah, I couldn't really think of a concise name for active_root_effect
I'm fine with whatever name we choose for the rune (as long as it makes sense), so I'll change it in a bit

@Ocean-OS Ocean-OS changed the title feat: add $effect.active rune feat: add $effect.allowed rune Jul 21, 2025
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.

a way to know if we're currently inside an effect tree
2 participants