From 5aff44a83fde800631d73737384c839bbfcee80a Mon Sep 17 00:00:00 2001 From: ComputerGuy <63362464+Ocean-OS@users.noreply.github.com> Date: Mon, 21 Jul 2025 02:20:33 -0700 Subject: [PATCH] rename to `$effect.allowed` --- .changeset/two-dancers-speak.md | 2 +- documentation/docs/02-runes/04-$effect.md | 12 ++++++------ packages/svelte/src/ambient.d.ts | 14 +++++++------- .../phases/2-analyze/visitors/CallExpression.js | 2 +- .../3-transform/client/visitors/CallExpression.js | 4 ++-- .../3-transform/server/visitors/CallExpression.js | 2 +- packages/svelte/src/internal/client/index.js | 2 +- .../src/internal/client/reactivity/effects.js | 10 +++++----- packages/svelte/src/utils.js | 2 +- .../samples/effect-active-rune/_config.js | 8 ++++++++ .../samples/effect-active-rune/main.svelte.js | 1 + packages/svelte/tests/signals/test.ts | 14 +++++++------- packages/svelte/types/index.d.ts | 14 +++++++------- 13 files changed, 48 insertions(+), 39 deletions(-) create mode 100644 packages/svelte/tests/compiler-errors/samples/effect-active-rune/_config.js create mode 100644 packages/svelte/tests/compiler-errors/samples/effect-active-rune/main.svelte.js 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