From dae7c3a4c2dedd6f39ff4d2ea2285f76afe5e026 Mon Sep 17 00:00:00 2001
From: Rich Harris <rich.harris@vercel.com>
Date: Fri, 26 Jul 2024 21:27:19 -0400
Subject: [PATCH] more direct example that shows unlinking and relinking

---
 packages/svelte/src/ambient.d.ts | 19 ++++++++++++-------
 packages/svelte/types/index.d.ts | 19 ++++++++++++-------
 2 files changed, 24 insertions(+), 14 deletions(-)

diff --git a/packages/svelte/src/ambient.d.ts b/packages/svelte/src/ambient.d.ts
index 5fc1931661..1cdd282467 100644
--- a/packages/svelte/src/ambient.d.ts
+++ b/packages/svelte/src/ambient.d.ts
@@ -127,17 +127,22 @@ declare namespace $state {
 	export function frozen<T>(): Readonly<T> | undefined;
 
 	/**
-	 * Declares reactive state that is linked to another value. Local reassignments will override the linked value
-	 * until the linked value changes.
+	 * Declares reactive state that is linked to another value. Local reassignments
+	 * will override the linked value until the linked value changes.
 	 *
 	 * Example:
 	 * ```ts
-	 * <script>
-	 *   let { text } = $props();
-	 *   let local_text = $state.link(text);
-	 * </script>
+	 * let a = $state(0);
+	 * let b = $state.link(a);
+
+	 * a = 1;
+	 * console.log(a, b); // 1, 1
+
+	 * b = 2; // unlink
+	 * console.log(a, b); // 1, 2
 	 *
-	 * <input type="text" bind:value={local_text} />
+	 * a = 3; // relink
+	 * console.log(a, b); // 3, 3
 	 * ```
 	 *
 	 * https://svelte-5-preview.vercel.app/docs/runes#$state-link
diff --git a/packages/svelte/types/index.d.ts b/packages/svelte/types/index.d.ts
index 56cc650abf..4d0f40041e 100644
--- a/packages/svelte/types/index.d.ts
+++ b/packages/svelte/types/index.d.ts
@@ -2898,17 +2898,22 @@ declare namespace $state {
 	export function frozen<T>(): Readonly<T> | undefined;
 
 	/**
-	 * Declares reactive state that is linked to another value. Local reassignments will override the linked value
-	 * until the linked value changes.
+	 * Declares reactive state that is linked to another value. Local reassignments
+	 * will override the linked value until the linked value changes.
 	 *
 	 * Example:
 	 * ```ts
-	 * <script>
-	 *   let { text } = $props();
-	 *   let local_text = $state.link(text);
-	 * </script>
+	 * let a = $state(0);
+	 * let b = $state.link(a);
+
+	 * a = 1;
+	 * console.log(a, b); // 1, 1
+
+	 * b = 2; // unlink
+	 * console.log(a, b); // 1, 2
 	 *
-	 * <input type="text" bind:value={local_text} />
+	 * a = 3; // relink
+	 * console.log(a, b); // 3, 3
 	 * ```
 	 *
 	 * https://svelte-5-preview.vercel.app/docs/runes#$state-link