From 75d41c78b7cc0e669fb582cd4645c23d9dd4b962 Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Thu, 12 Feb 2026 18:55:55 -0500 Subject: [PATCH] tweak inline docs --- documentation/docs/02-runes/04-$effect.md | 4 +++- packages/svelte/src/ambient.d.ts | 16 +++++++++------- packages/svelte/types/index.d.ts | 16 +++++++++------- 3 files changed, 21 insertions(+), 15 deletions(-) diff --git a/documentation/docs/02-runes/04-$effect.md b/documentation/docs/02-runes/04-$effect.md index 4ed22688db..5afb9fb783 100644 --- a/documentation/docs/02-runes/04-$effect.md +++ b/documentation/docs/02-runes/04-$effect.md @@ -269,13 +269,15 @@ The `$effect.allowed` rune is an advanced feature that indicates whether or not function onclick() { console.log('after component setup', $effect.allowed()); // false - $effect.root(() => { + const destroy = $effect.root(() => { console.log('in root effect', $effect.allowed()); // true return () => { console.log('in effect teardown', $effect.allowed()); // false }; }); + + destroy(); } diff --git a/packages/svelte/src/ambient.d.ts b/packages/svelte/src/ambient.d.ts index 591bdc99c5..0501cfc197 100644 --- a/packages/svelte/src/ambient.d.ts +++ b/packages/svelte/src/ambient.d.ts @@ -268,21 +268,23 @@ declare namespace $effect { * * function onclick() { * console.log('after component setup', $effect.allowed()); // false - * } - * function ondblclick() { - * $effect.root(() => { + * + * const destroy = $effect.root(() => { * console.log('in root effect', $effect.allowed()); // true + * * return () => { * console.log('in effect teardown', $effect.allowed()); // false - * } - * })(); + * }; + * }); + * + * destroy(); * } * + * * - * * ``` * - * https://svelte.dev/docs/svelte/$effect#$effect.allowed + * @see {@link https://svelte.dev/docs/svelte/$effect#$effect.allowed Documentation} */ export function allowed(): boolean; /** diff --git a/packages/svelte/types/index.d.ts b/packages/svelte/types/index.d.ts index a7fc11db30..fa62d48fe8 100644 --- a/packages/svelte/types/index.d.ts +++ b/packages/svelte/types/index.d.ts @@ -3447,21 +3447,23 @@ declare namespace $effect { * * function onclick() { * console.log('after component setup', $effect.allowed()); // false - * } - * function ondblclick() { - * $effect.root(() => { + * + * const destroy = $effect.root(() => { * console.log('in root effect', $effect.allowed()); // true + * * return () => { * console.log('in effect teardown', $effect.allowed()); // false - * } - * })(); + * }; + * }); + * + * destroy(); * } * + * * - * * ``` * - * https://svelte.dev/docs/svelte/$effect#$effect.allowed + * @see {@link https://svelte.dev/docs/svelte/$effect#$effect.allowed Documentation} */ export function allowed(): boolean; /**