Skip to content

Commit 32cee9f

Browse files
committed
tweak jsdoc description
1 parent 0adad95 commit 32cee9f

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

packages/svelte/src/ambient.d.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ declare namespace $state {
9494
: never;
9595

9696
/**
97-
* Forces an update on a `$state` or `$state.raw` variable or class field.
97+
* Forces an update on a variable or class field declared with `$state` or `$state.raw`, or a property of a `$state` object.
9898
* This is primarily meant as an escape hatch to be able to use external or native classes
9999
* with Svelte's reactivity system.
100100
* If you used Svelte 3 or 4, this is the equivalent of `foo = foo`.
@@ -114,6 +114,8 @@ declare namespace $state {
114114
* Count is {counter.count}
115115
* </button>
116116
* ```
117+
*
118+
* https://svelte.dev/docs/svelte/$state#$state.invalidate
117119
*/
118120
export function invalidate(source: unknown): void;
119121

packages/svelte/types/index.d.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2926,7 +2926,7 @@ declare namespace $state {
29262926
: never;
29272927

29282928
/**
2929-
* Forces an update on a `$state` or `$state.raw` variable or class field.
2929+
* Forces an update on a variable or class field declared with `$state` or `$state.raw`, or a property of a `$state` object.
29302930
* This is primarily meant as an escape hatch to be able to use external or native classes
29312931
* with Svelte's reactivity system.
29322932
* If you used Svelte 3 or 4, this is the equivalent of `foo = foo`.
@@ -2946,6 +2946,8 @@ declare namespace $state {
29462946
* Count is {counter.count}
29472947
* </button>
29482948
* ```
2949+
*
2950+
* https://svelte.dev/docs/svelte/$state#$state.invalidate
29492951
*/
29502952
export function invalidate(source: unknown): void;
29512953

0 commit comments

Comments
 (0)