Skip to content

Commit 1e4547b

Browse files
authored
chore: add @since tags for settled and experimental.async (#16371)
* chore: add `@since` tag for `settled` * same for compiler options * regenerate
1 parent 79904b7 commit 1e4547b

File tree

3 files changed

+27
-7
lines changed

3 files changed

+27
-7
lines changed

packages/svelte/src/compiler/types/index.d.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,9 +224,15 @@ export interface ModuleCompileOptions {
224224
* Use this to filter out warnings. Return `true` to keep the warning, `false` to discard it.
225225
*/
226226
warningFilter?: (warning: Warning) => boolean;
227-
/** Experimental options */
227+
/**
228+
* Experimental options
229+
* @since 5.36
230+
*/
228231
experimental?: {
229-
/** Allow `await` keyword in deriveds, template expressions, and the top level of components */
232+
/**
233+
* Allow `await` keyword in deriveds, template expressions, and the top level of components
234+
* @since 5.36
235+
*/
230236
async?: boolean;
231237
};
232238
}

packages/svelte/src/internal/client/runtime.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -526,6 +526,7 @@ export async function tick() {
526526
* Returns a promise that resolves once any state changes, and asynchronous work resulting from them,
527527
* have resolved and the DOM has been updated
528528
* @returns {Promise<void>}
529+
* @since 5.36
529530
*/
530531
export function settled() {
531532
return Batch.ensure().settled();

packages/svelte/types/index.d.ts

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,8 @@ declare module 'svelte' {
528528
/**
529529
* Returns a promise that resolves once any state changes, and asynchronous work resulting from them,
530530
* have resolved and the DOM has been updated
531-
* */
531+
* @since 5.36
532+
*/
532533
export function settled(): Promise<void>;
533534
/**
534535
* When used inside a [`$derived`](https://svelte.dev/docs/svelte/$derived) or [`$effect`](https://svelte.dev/docs/svelte/$effect),
@@ -1116,9 +1117,15 @@ declare module 'svelte/compiler' {
11161117
* Use this to filter out warnings. Return `true` to keep the warning, `false` to discard it.
11171118
*/
11181119
warningFilter?: (warning: Warning) => boolean;
1119-
/** Experimental options */
1120+
/**
1121+
* Experimental options
1122+
* @since 5.36
1123+
*/
11201124
experimental?: {
1121-
/** Allow `await` keyword in deriveds, template expressions, and the top level of components */
1125+
/**
1126+
* Allow `await` keyword in deriveds, template expressions, and the top level of components
1127+
* @since 5.36
1128+
*/
11221129
async?: boolean;
11231130
};
11241131
}
@@ -3031,9 +3038,15 @@ declare module 'svelte/types/compiler/interfaces' {
30313038
* Use this to filter out warnings. Return `true` to keep the warning, `false` to discard it.
30323039
*/
30333040
warningFilter?: (warning: Warning_1) => boolean;
3034-
/** Experimental options */
3041+
/**
3042+
* Experimental options
3043+
* @since 5.36
3044+
*/
30353045
experimental?: {
3036-
/** Allow `await` keyword in deriveds, template expressions, and the top level of components */
3046+
/**
3047+
* Allow `await` keyword in deriveds, template expressions, and the top level of components
3048+
* @since 5.36
3049+
*/
30373050
async?: boolean;
30383051
};
30393052
}

0 commit comments

Comments
 (0)