|
| 1 | +--- |
| 2 | +title: await |
| 3 | +--- |
| 4 | + |
| 5 | +As of Svelte 5.36, you can use the `await` keyword inside your components in three places where it was previously unavailable: |
| 6 | + |
| 7 | +- at the top level of your component's `<script>` |
| 8 | +- inside `$derived(...)` declarations |
| 9 | +- inside your markup |
| 10 | + |
| 11 | +This feature is currently experimental, and you must opt in by adding the `experimental.async` option wherever you [configure](/docs/kit/configuration) Svelte, usually `svelte.config.js`: |
| 12 | + |
| 13 | +```js |
| 14 | +/// file: svelte.config.js |
| 15 | +export default { |
| 16 | + compilerOptions: { |
| 17 | + experimental: { |
| 18 | + async: true |
| 19 | + } |
| 20 | + } |
| 21 | +}; |
| 22 | +``` |
| 23 | + |
| 24 | +The experimental flag will be removed in Svelte 6. |
| 25 | + |
| 26 | +## Boundaries |
| 27 | + |
| 28 | +Currently, you can only use `await` inside a [`<svelte:boundary>`](svelte-boundary) with a `pending` snippet: |
| 29 | + |
| 30 | +```svelte |
| 31 | +<svelte:boundary> |
| 32 | + <MyApp /> |
| 33 | +
|
| 34 | + {#snippet pending()} |
| 35 | + <p>loading...</p> |
| 36 | + {/snippet} |
| 37 | +</svelte:boundary> |
| 38 | +``` |
| 39 | + |
| 40 | +This restriction will be lifted once Svelte supports asynchronous server-side rendering (see [caveats](#Caveats)). |
| 41 | + |
| 42 | +> [!NOTE] In the [playground](/playground), your app is rendered inside a boundary with an empty pending snippet, so that you can use `await` without having to create one. |
| 43 | +
|
| 44 | +## Synchronized updates |
| 45 | + |
| 46 | +When an `await` expression depends on a particular piece of state, changes to that state will not be reflected in the UI until the asynchronous work has completed, so that the UI is not left in an inconsistent state. In other words, in an example like [this](/playground/untitled#H4sIAAAAAAAAE42QsWrDQBBEf2VZUkhYRE4gjSwJ0qVMkS6XYk9awcFpJe5Wdoy4fw-ycdykSPt2dpiZFYVGxgrf2PsJTlPwPWTcO-U-xwIH5zli9bminudNtwEsbl-v8_wYj-x1Y5Yi_8W7SZRFI1ZYxy64WVsjRj0rEDTwEJWUs6f8cKP2Tp8vVIxSPEsHwyKdukmA-j6jAmwO63Y1SidyCsIneA_T6CJn2ZBD00Jk_XAjT4tmQwEv-32eH6AsgYK6wXWOPPTs6Xy1CaxLECDYgb3kSUbq8p5aaifzorCt0RiUZbQcDIJ10ldH8gs3K6X2Xzqbro5zu1KCHaw2QQPrtclvwVSXc2sEC1T-Vqw0LJy-ClRy_uSkx2ogHzn9ADZ1CubKAQAA)... |
| 47 | + |
| 48 | +```svelte |
| 49 | +<script> |
| 50 | + let a = $state(1); |
| 51 | + let b = $state(2); |
| 52 | +
|
| 53 | + async function add(a, b) { |
| 54 | + await new Promise((f) => setTimeout(f, 500)); // artificial delay |
| 55 | + return a + b; |
| 56 | + } |
| 57 | +</script> |
| 58 | +
|
| 59 | +<input type="number" bind:value={a}> |
| 60 | +<input type="number" bind:value={b}> |
| 61 | +
|
| 62 | +<p>{a} + {b} = {await add(a, b)}</p> |
| 63 | +``` |
| 64 | + |
| 65 | +...if you increment `a`, the contents of the `<p>` will _not_ immediately update to read this — |
| 66 | + |
| 67 | +```html |
| 68 | +<p>2 + 2 = 3</p> |
| 69 | +``` |
| 70 | + |
| 71 | +— instead, the text will update to `2 + 2 = 4` when `add(a, b)` resolves. |
| 72 | + |
| 73 | +Updates can overlap — a fast update will be reflected in the UI while an earlier slow update is still ongoing. |
| 74 | + |
| 75 | +## Concurrency |
| 76 | + |
| 77 | +Svelte will do as much asynchronous work as it can in parallel. For example if you have two `await` expressions in your markup... |
| 78 | + |
| 79 | +```svelte |
| 80 | +<p>{await one()}</p> |
| 81 | +<p>{await two()}</p> |
| 82 | +``` |
| 83 | + |
| 84 | +...both functions will run at the same time, as they are independent expressions, even though they are _visually_ sequential. |
| 85 | + |
| 86 | +This does not apply to sequential `await` expressions inside your `<script>` or inside async functions — these run like any other asynchronous JavaScript. An exception is that independent `$derived` expressions will update independently, even though they will run sequentially when they are first created: |
| 87 | + |
| 88 | +```js |
| 89 | +async function one() { return 1; } |
| 90 | +async function two() { return 2; } |
| 91 | +// ---cut--- |
| 92 | +// these will run sequentially the first time, |
| 93 | +// but will update independently |
| 94 | +let a = $derived(await one()); |
| 95 | +let b = $derived(await two()); |
| 96 | +``` |
| 97 | + |
| 98 | +> [!NOTE] If you write code like this, expect Svelte to give you an [`await_waterfall`](runtime-warnings#Client-warnings-await_waterfall) warning |
| 99 | +
|
| 100 | +## Indicating loading states |
| 101 | + |
| 102 | +In addition to the nearest boundary's [`pending`](svelte-boundary#Properties-pending) snippet, you can indicate that asynchronous work is ongoing with [`$effect.pending()`]($effect#$effect.pending). |
| 103 | + |
| 104 | +You can also use [`settled()`](svelte#settled) to get a promise that resolves when the current update is complete: |
| 105 | + |
| 106 | +```js |
| 107 | +let color = 'red'; |
| 108 | +let answer = -1; |
| 109 | +let updating = false; |
| 110 | +// ---cut--- |
| 111 | +import { tick, settled } from 'svelte'; |
| 112 | + |
| 113 | +async function onclick() { |
| 114 | + updating = true; |
| 115 | + |
| 116 | + // without this, the change to `updating` will be |
| 117 | + // grouped with the other changes, meaning it |
| 118 | + // won't be reflected in the UI |
| 119 | + await tick(); |
| 120 | + |
| 121 | + color = 'octarine'; |
| 122 | + answer = 42; |
| 123 | + |
| 124 | + await settled(); |
| 125 | + |
| 126 | + // any updates affected by `color` or `answer` |
| 127 | + // have now been applied |
| 128 | + updating = false; |
| 129 | +} |
| 130 | +``` |
| 131 | + |
| 132 | +## Error handling |
| 133 | + |
| 134 | +Errors in `await` expressions will bubble to the nearest [error boundary](svelte-boundary). |
| 135 | + |
| 136 | +## Caveats |
| 137 | + |
| 138 | +As an experimental feature, the details of how `await` is handled (and related APIs like `$effect.pending()`) are subject to breaking changes outside of a semver major release, though we intend to keep such changes to a bare minimum. |
| 139 | + |
| 140 | +Currently, server-side rendering is synchronous. If a `<svelte:boundary>` with a `pending` snippet is encountered during SSR, only the `pending` snippet will be rendered. |
| 141 | + |
| 142 | +## Breaking changes |
| 143 | + |
| 144 | +Effects run in a slightly different order when the `experimental.async` option is `true`. Specifically, _block_ effects like `{#if ...}` and `{#each ...}` now run before an `$effect.pre` or `beforeUpdate` in the same component, which means that in [very rare situations](/playground/untitled?#H4sIAAAAAAAAE22R3VLDIBCFX2WLvUhnTHsf0zre-Q7WmfwtFV2BgU1rJ5N3F0jaOuoVcPbw7VkYhK4_URTiGYkMnIyjDjLsFGO3EvdCKkIvipdB8NlGXxSCPt96snbtj0gctab2-J_eGs2oOWBE6VunLO_2es-EDKZ5x5ZhC0vPNWM2gHXGouNzAex6hHH1cPHil_Lsb95YT9VQX6KUAbS2DrNsBdsdDFHe8_XSYjH1SrhELTe3MLpsemajweiWVPuxHSbKNd-8eQTdE0EBf4OOaSg2hwNhhE_ABB_ulJzjj9FULvIcqgm5vnAqUB7wWFMfhuugQWkcAr8hVD-mq8D12kOep24J_IszToOXdveGDsuNnZwbJUNlXsKnhJdhUcTo42s41YpOSneikDV5HL8BktM6yRcCAAA=) it is possible to update a block that should no longer exist, but only if you update state inside an effect, [which you should avoid]($effect#When-not-to-use-$effect). |
0 commit comments