Navigating…
+{/if} +``` + +## Related + +- `$app/navigation`, `$app/stores` diff --git a/definitions/$app.stores.md b/definitions/$app.stores.md new file mode 100644 index 0000000..4988955 --- /dev/null +++ b/definitions/$app.stores.md @@ -0,0 +1,30 @@ +# $app/stores Definition + +**Definition:** Client-accessible Svelte stores reflecting navigation +state. + +Note: Deprecated in SvelteKit 2.12+ in favor of `$app/state` (use +identical APIs via runes). Existing apps may still use `$app/stores`. + +**Syntax:** `import { page, navigating, updated } from '$app/stores'` + +**Stores:** + +- `page` — `ReadableLoading…
{/if} +``` + +## Related + +- `$app/state`, `$app/navigation`, `load` diff --git a/definitions/$derived.by.md b/definitions/$derived.by.md index 1eaf93b..d0fd880 100644 --- a/definitions/$derived.by.md +++ b/definitions/$derived.by.md @@ -12,10 +12,10 @@ computations ## Examples -```js +```ts // Expensive computation that should be memoized -let items = $state([1, 2, 3, 4, 5]); -let filter = $state('even'); +let items: number[] = $state([1, 2, 3, 4, 5]); +let filter: 'even' | 'odd' = $state('even'); const expensiveResult = $derived.by(() => { console.log('Computing expensive result...'); @@ -47,7 +47,7 @@ const processedData = $derived.by(() => { // When you need multiple statements const validation = $derived.by(() => { - const errors = []; + const errors: string[] = []; if (items.length === 0) { errors.push('Items cannot be empty'); @@ -62,6 +62,28 @@ const validation = $derived.by(() => { errors, }; }); + +// Override a derived temporarily (e.g., optimistic UI) +let likes = $derived(post.likes); +async function like() { + likes += 1; // override + try { + await sendLike(); + } catch { + likes -= 1; // rollback on error + } +} + +// Destructuring: each piece remains reactive +let { a, b } = $derived(getPair()); // each remains reactive + +// Dependency control +let total2 = $derived.by(() => { + // anything read synchronously is a dependency + return items.reduce((s, n) => s + n, 0); +}); + +// To exempt values from tracking, use untrack(...) ``` ## Related diff --git a/definitions/$env.dynamic.private.md b/definitions/$env.dynamic.private.md new file mode 100644 index 0000000..a128377 --- /dev/null +++ b/definitions/$env.dynamic.private.md @@ -0,0 +1,23 @@ +# $env/dynamic/private Definition + +**Definition:** Runtime (dynamic) private environment variables +available on the server. Excludes variables with `publicPrefix` and +includes those with `privatePrefix` (if configured). + +**Syntax:** `import { env } from '$env/dynamic/private'` + +**Notes:** + +- Server-only; cannot be imported in client code. +- In dev, includes vars from `.env`; in prod, depends on adapter. + +## Example + +```ts +import { env } from '$env/dynamic/private'; +const secret = env.SECRET_API_KEY; +``` + +## Related + +- `$env/static/private`, `$env/dynamic/public` diff --git a/definitions/$env.dynamic.public.md b/definitions/$env.dynamic.public.md new file mode 100644 index 0000000..a07c1ce --- /dev/null +++ b/definitions/$env.dynamic.public.md @@ -0,0 +1,23 @@ +# $env/dynamic/public Definition + +**Definition:** Runtime (dynamic) public environment variables safe +for client usage. Includes only variables with `publicPrefix` (default +`PUBLIC_`). + +**Syntax:** `import { env } from '$env/dynamic/public'` + +**Notes:** + +- Public dynamic vars are sent from server to client; prefer + `$env/static/public` when possible. + +## Example + +```ts +import { env } from '$env/dynamic/public'; +const base = env.PUBLIC_BASE_URL; +``` + +## Related + +- `$env/static/public`, `$env/dynamic/private` diff --git a/definitions/$env.static.private.md b/definitions/$env.static.private.md new file mode 100644 index 0000000..dbc5c63 --- /dev/null +++ b/definitions/$env.static.private.md @@ -0,0 +1,24 @@ +# $env/static/private Definition + +**Definition:** Build-time (static) private environment variables +injected by Vite from `.env` and `process.env`. Excludes +`publicPrefix` and includes `privatePrefix` (if configured). + +**Syntax:** `import { NAME } from '$env/static/private'` + +**Notes:** + +- Values are statically replaced at build time; enables dead code + elimination. +- Declare all referenced variables (even if empty) to avoid undefined + at build. + +## Example + +```ts +import { API_KEY } from '$env/static/private'; +``` + +## Related + +- `$env/dynamic/private`, `$env/static/public` diff --git a/definitions/$env.static.public.md b/definitions/$env.static.public.md new file mode 100644 index 0000000..41f03b0 --- /dev/null +++ b/definitions/$env.static.public.md @@ -0,0 +1,21 @@ +# $env/static/public Definition + +**Definition:** Build-time (static) public environment variables safe +for client usage. Includes only variables with `publicPrefix` (default +`PUBLIC_`). + +**Syntax:** `import { PUBLIC_... } from '$env/static/public'` + +**Notes:** + +- Values are statically replaced at build time. + +## Example + +```ts +import { PUBLIC_BASE_URL } from '$env/static/public'; +``` + +## Related + +- `$env/static/private`, `$env/dynamic/public` diff --git a/definitions/$state.md b/definitions/$state.md index 10ae26c..c74d338 100644 --- a/definitions/$state.md +++ b/definitions/$state.md @@ -1,33 +1,44 @@ # $state Definition -**Definition:** Creates reactive state that triggers UI updates when -the value changes -**Syntax:** `$state