From 37f66ca7e5e9eeb186b37af714898d7cafa4e65c Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot Date: Thu, 5 Jun 2025 19:12:01 +0000 Subject: [PATCH] sync docs --- .../98-reference/.generated/client-errors.md | 6 +++ .../.generated/client-warnings.md | 16 ++++++ .../98-reference/.generated/compile-errors.md | 12 +++++ .../98-reference/.generated/shared-errors.md | 8 +++ .../docs/svelte/98-reference/20-svelte.md | 51 +++++++++++++++++++ .../svelte/98-reference/21-svelte-compiler.md | 26 ++++++++++ .../svelte/98-reference/30-compiler-errors.md | 12 +++++ .../svelte/98-reference/30-runtime-errors.md | 14 +++++ .../98-reference/30-runtime-warnings.md | 16 ++++++ 9 files changed, 161 insertions(+) diff --git a/apps/svelte.dev/content/docs/svelte/98-reference/.generated/client-errors.md b/apps/svelte.dev/content/docs/svelte/98-reference/.generated/client-errors.md index 32348bb781..b9268636b2 100644 --- a/apps/svelte.dev/content/docs/svelte/98-reference/.generated/client-errors.md +++ b/apps/svelte.dev/content/docs/svelte/98-reference/.generated/client-errors.md @@ -110,6 +110,12 @@ Rest element properties of `$props()` such as `%property%` are readonly The `%rune%` rune is only available inside `.svelte` and `.svelte.js/ts` files ``` +### set_context_after_init + +``` +`setContext` must be called when a component first initializes, not in a subsequent effect or after an `await` expression +``` + ### state_descriptors_fixed ``` diff --git a/apps/svelte.dev/content/docs/svelte/98-reference/.generated/client-warnings.md b/apps/svelte.dev/content/docs/svelte/98-reference/.generated/client-warnings.md index fe90b0db38..b49d4aae8d 100644 --- a/apps/svelte.dev/content/docs/svelte/98-reference/.generated/client-warnings.md +++ b/apps/svelte.dev/content/docs/svelte/98-reference/.generated/client-warnings.md @@ -34,6 +34,22 @@ function add() { } ``` +### await_reactivity_loss + +``` +Detected reactivity loss +``` + +TODO + +### await_waterfall + +``` +An async value (%location%) was not read immediately after it resolved. This often indicates an unnecessary waterfall, which can slow down your app. +``` + +TODO + ### binding_property_non_reactive ``` diff --git a/apps/svelte.dev/content/docs/svelte/98-reference/.generated/compile-errors.md b/apps/svelte.dev/content/docs/svelte/98-reference/.generated/compile-errors.md index db848a0299..20f57770d1 100644 --- a/apps/svelte.dev/content/docs/svelte/98-reference/.generated/compile-errors.md +++ b/apps/svelte.dev/content/docs/svelte/98-reference/.generated/compile-errors.md @@ -480,6 +480,12 @@ Expected token %token% Expected whitespace ``` +### experimental_async + +``` +Cannot use `await` in deriveds and template expressions, or at the top level of a component, unless the `experimental.async` compiler option is `true` +``` + ### export_undefined ``` @@ -534,6 +540,12 @@ The arguments keyword cannot be used within the template or at the top level of %message% ``` +### legacy_await_invalid + +``` +Cannot use `await` in deriveds and template expressions, or at the top level of a component, unless in runes mode +``` + ### legacy_export_invalid ``` diff --git a/apps/svelte.dev/content/docs/svelte/98-reference/.generated/shared-errors.md b/apps/svelte.dev/content/docs/svelte/98-reference/.generated/shared-errors.md index 6c31aaafd0..ac31e22c75 100644 --- a/apps/svelte.dev/content/docs/svelte/98-reference/.generated/shared-errors.md +++ b/apps/svelte.dev/content/docs/svelte/98-reference/.generated/shared-errors.md @@ -1,5 +1,13 @@ +### await_outside_boundary + +``` +Cannot await outside a `` with a `pending` snippet +``` + +TODO + ### invalid_default_snippet ``` diff --git a/apps/svelte.dev/content/docs/svelte/98-reference/20-svelte.md b/apps/svelte.dev/content/docs/svelte/98-reference/20-svelte.md index ae1a439043..00d31ceee6 100644 --- a/apps/svelte.dev/content/docs/svelte/98-reference/20-svelte.md +++ b/apps/svelte.dev/content/docs/svelte/98-reference/20-svelte.md @@ -15,6 +15,7 @@ import { createEventDispatcher, createRawSnippet, flushSync, + getAbortSignal, getAllContexts, getContext, hasContext, @@ -23,6 +24,7 @@ import { onDestroy, onMount, setContext, + settled, tick, unmount, untrack @@ -291,6 +293,40 @@ function flushSync(fn?: (() => T) | undefined): T; +## getAbortSignal + +Returns an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that aborts when the current [derived](/docs/svelte/$derived) or [effect](/docs/svelte/$effect) re-runs or is destroyed. + +Must be called while a derived or effect is running. + +```svelte + +``` + +
+ +```dts +function getAbortSignal(): AbortSignal; +``` + +
+ + + ## getAllContexts Retrieves the whole context map that belongs to the closest parent component. @@ -461,6 +497,21 @@ function setContext(key: any, context: T): T; +## settled + +Returns a promise that resolves once any state changes, and asynchronous work resulting from them, +have resolved and the DOM has been updated + +
+ +```dts +function settled(): Promise; +``` + +
+ + + ## tick Returns a promise that resolves once any pending state changes have been applied. diff --git a/apps/svelte.dev/content/docs/svelte/98-reference/21-svelte-compiler.md b/apps/svelte.dev/content/docs/svelte/98-reference/21-svelte-compiler.md index 7910930f91..e21aef9f24 100644 --- a/apps/svelte.dev/content/docs/svelte/98-reference/21-svelte-compiler.md +++ b/apps/svelte.dev/content/docs/svelte/98-reference/21-svelte-compiler.md @@ -1247,6 +1247,32 @@ warningFilter?: (warning: Warning) => boolean; A function that gets a `Warning` as an argument and returns a boolean. Use this to filter out warnings. Return `true` to keep the warning, `false` to discard it. + + + +
+ +```dts +experimental?: {/*…*/} +``` + +
+ +Experimental options + +
+ +```dts +async?: boolean; +``` + +
+ +Allow `await` keyword in deriveds, template expressions, and the top level of components + +
+
+
diff --git a/apps/svelte.dev/content/docs/svelte/98-reference/30-compiler-errors.md b/apps/svelte.dev/content/docs/svelte/98-reference/30-compiler-errors.md index 143137c77e..186d322adb 100644 --- a/apps/svelte.dev/content/docs/svelte/98-reference/30-compiler-errors.md +++ b/apps/svelte.dev/content/docs/svelte/98-reference/30-compiler-errors.md @@ -485,6 +485,12 @@ Expected token %token% Expected whitespace ``` +### experimental_async + +``` +Cannot use `await` in deriveds and template expressions, or at the top level of a component, unless the `experimental.async` compiler option is `true` +``` + ### export_undefined ``` @@ -539,6 +545,12 @@ The arguments keyword cannot be used within the template or at the top level of %message% ``` +### legacy_await_invalid + +``` +Cannot use `await` in deriveds and template expressions, or at the top level of a component, unless in runes mode +``` + ### legacy_export_invalid ``` diff --git a/apps/svelte.dev/content/docs/svelte/98-reference/30-runtime-errors.md b/apps/svelte.dev/content/docs/svelte/98-reference/30-runtime-errors.md index 51ab77d1f1..5bea176522 100644 --- a/apps/svelte.dev/content/docs/svelte/98-reference/30-runtime-errors.md +++ b/apps/svelte.dev/content/docs/svelte/98-reference/30-runtime-errors.md @@ -117,6 +117,12 @@ Rest element properties of `$props()` such as `%property%` are readonly The `%rune%` rune is only available inside `.svelte` and `.svelte.js/ts` files ``` +### set_context_after_init + +``` +`setContext` must be called when a component first initializes, not in a subsequent effect or after an `await` expression +``` + ### state_descriptors_fixed ``` @@ -184,6 +190,14 @@ Certain methods such as `mount` cannot be invoked while running in a server cont +### await_outside_boundary + +``` +Cannot await outside a `` with a `pending` snippet +``` + +TODO + ### invalid_default_snippet ``` diff --git a/apps/svelte.dev/content/docs/svelte/98-reference/30-runtime-warnings.md b/apps/svelte.dev/content/docs/svelte/98-reference/30-runtime-warnings.md index 5a0b6b9488..41e0b149b1 100644 --- a/apps/svelte.dev/content/docs/svelte/98-reference/30-runtime-warnings.md +++ b/apps/svelte.dev/content/docs/svelte/98-reference/30-runtime-warnings.md @@ -41,6 +41,22 @@ function add() { } ``` +### await_reactivity_loss + +``` +Detected reactivity loss +``` + +TODO + +### await_waterfall + +``` +An async value (%location%) was not read immediately after it resolved. This often indicates an unnecessary waterfall, which can slow down your app. +``` + +TODO + ### binding_property_non_reactive ```