Skip to content

Commit 2cc2e7b

Browse files
committed
fix: mark function properties on runes as deprecated for better intellisense
Ensures that IDEs will order the to the bottom so that the rune variants are on top, better visible closes #11437
1 parent 6e5ab2e commit 2cc2e7b

File tree

3 files changed

+131
-0
lines changed

3 files changed

+131
-0
lines changed

.changeset/four-balloons-beam.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"svelte": patch
3+
---
4+
5+
fix: mark function properties on runes as deprecated for better intellisense

packages/svelte/src/ambient.d.ts

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,27 @@ declare namespace $state {
6262
* @param state The value to snapshot
6363
*/
6464
export function snapshot<T>(state: T): T;
65+
66+
// prevent intellisense from being unhelpful
67+
/** @deprecated */
68+
export const apply: never;
69+
/** @deprecated */
70+
// @ts-ignore
71+
export const arguments: never;
72+
/** @deprecated */
73+
export const bind: never;
74+
/** @deprecated */
75+
export const call: never;
76+
/** @deprecated */
77+
export const caller: never;
78+
/** @deprecated */
79+
export const length: never;
80+
/** @deprecated */
81+
export const name: never;
82+
/** @deprecated */
83+
export const prototype: never;
84+
/** @deprecated */
85+
export const toString: never;
6586
}
6687

6788
/**
@@ -98,6 +119,27 @@ declare namespace $derived {
98119
* https://svelte-5-preview.vercel.app/docs/runes#$derived-by
99120
*/
100121
export function by<T>(fn: () => T): T;
122+
123+
// prevent intellisense from being unhelpful
124+
/** @deprecated */
125+
export const apply: never;
126+
/** @deprecated */
127+
// @ts-ignore
128+
export const arguments: never;
129+
/** @deprecated */
130+
export const bind: never;
131+
/** @deprecated */
132+
export const call: never;
133+
/** @deprecated */
134+
export const caller: never;
135+
/** @deprecated */
136+
export const length: never;
137+
/** @deprecated */
138+
export const name: never;
139+
/** @deprecated */
140+
export const prototype: never;
141+
/** @deprecated */
142+
export const toString: never;
101143
}
102144

103145
/**
@@ -186,6 +228,27 @@ declare namespace $effect {
186228
* https://svelte-5-preview.vercel.app/docs/runes#$effect-root
187229
*/
188230
export function root(fn: () => void | (() => void)): () => void;
231+
232+
// prevent intellisense from being unhelpful
233+
/** @deprecated */
234+
export const apply: never;
235+
/** @deprecated */
236+
// @ts-ignore
237+
export const arguments: never;
238+
/** @deprecated */
239+
export const bind: never;
240+
/** @deprecated */
241+
export const call: never;
242+
/** @deprecated */
243+
export const caller: never;
244+
/** @deprecated */
245+
export const length: never;
246+
/** @deprecated */
247+
export const name: never;
248+
/** @deprecated */
249+
export const prototype: never;
250+
/** @deprecated */
251+
export const toString: never;
189252
}
190253

191254
/**

packages/svelte/types/index.d.ts

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2623,6 +2623,27 @@ declare namespace $state {
26232623
* @param state The value to snapshot
26242624
*/
26252625
export function snapshot<T>(state: T): T;
2626+
2627+
// prevent intellisense from being unhelpful
2628+
/** @deprecated */
2629+
export const apply: never;
2630+
/** @deprecated */
2631+
// @ts-ignore
2632+
export const arguments: never;
2633+
/** @deprecated */
2634+
export const bind: never;
2635+
/** @deprecated */
2636+
export const call: never;
2637+
/** @deprecated */
2638+
export const caller: never;
2639+
/** @deprecated */
2640+
export const length: never;
2641+
/** @deprecated */
2642+
export const name: never;
2643+
/** @deprecated */
2644+
export const prototype: never;
2645+
/** @deprecated */
2646+
export const toString: never;
26262647
}
26272648

26282649
/**
@@ -2659,6 +2680,27 @@ declare namespace $derived {
26592680
* https://svelte-5-preview.vercel.app/docs/runes#$derived-by
26602681
*/
26612682
export function by<T>(fn: () => T): T;
2683+
2684+
// prevent intellisense from being unhelpful
2685+
/** @deprecated */
2686+
export const apply: never;
2687+
/** @deprecated */
2688+
// @ts-ignore
2689+
export const arguments: never;
2690+
/** @deprecated */
2691+
export const bind: never;
2692+
/** @deprecated */
2693+
export const call: never;
2694+
/** @deprecated */
2695+
export const caller: never;
2696+
/** @deprecated */
2697+
export const length: never;
2698+
/** @deprecated */
2699+
export const name: never;
2700+
/** @deprecated */
2701+
export const prototype: never;
2702+
/** @deprecated */
2703+
export const toString: never;
26622704
}
26632705

26642706
/**
@@ -2747,6 +2789,27 @@ declare namespace $effect {
27472789
* https://svelte-5-preview.vercel.app/docs/runes#$effect-root
27482790
*/
27492791
export function root(fn: () => void | (() => void)): () => void;
2792+
2793+
// prevent intellisense from being unhelpful
2794+
/** @deprecated */
2795+
export const apply: never;
2796+
/** @deprecated */
2797+
// @ts-ignore
2798+
export const arguments: never;
2799+
/** @deprecated */
2800+
export const bind: never;
2801+
/** @deprecated */
2802+
export const call: never;
2803+
/** @deprecated */
2804+
export const caller: never;
2805+
/** @deprecated */
2806+
export const length: never;
2807+
/** @deprecated */
2808+
export const name: never;
2809+
/** @deprecated */
2810+
export const prototype: never;
2811+
/** @deprecated */
2812+
export const toString: never;
27502813
}
27512814

27522815
/**

0 commit comments

Comments
 (0)