diff --git a/.changeset/two-dancers-speak.md b/.changeset/two-dancers-speak.md index 7044eaa329..b0d8d394d0 100644 --- a/.changeset/two-dancers-speak.md +++ b/.changeset/two-dancers-speak.md @@ -2,4 +2,4 @@ 'svelte': minor --- -feat: add `$effect.active` rune +feat: add `$effect.allowed` rune diff --git a/documentation/docs/02-runes/04-$effect.md b/documentation/docs/02-runes/04-$effect.md index 4a27a72778..59010c981f 100644 --- a/documentation/docs/02-runes/04-$effect.md +++ b/documentation/docs/02-runes/04-$effect.md @@ -255,22 +255,22 @@ const destroy = $effect.root(() => { destroy(); ``` -## `$effect.active` +## `$effect.allowed` -The `$effect.active` rune is an advanced feature that indicates whether or not an effect or [async `$derived`](await-expressions) can be created in the current context. To improve performance and memory efficiency, effects and async deriveds can only be created when a root effect is active. Root effects are created during component setup, but they can also be programmatically created via `$effect.root`. +The `$effect.allowed` rune is an advanced feature that indicates whether or not an effect or [async `$derived`](await-expressions) can be created in the current context. To improve performance and memory efficiency, effects and async deriveds can only be created when a root effect is active. Root effects are created during component setup, but they can also be programmatically created via `$effect.root`. ```svelte