chore: add `@since` tags for `settled` and `experimental.async` (#16371)

* chore: add `@since` tag for `settled`

* same for compiler options

* regenerate
pull/16373/head
Rich Harris 2 months ago committed by GitHub
parent 79904b7113
commit 1e4547b005
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -224,9 +224,15 @@ export interface ModuleCompileOptions {
* Use this to filter out warnings. Return `true` to keep the warning, `false` to discard it. * Use this to filter out warnings. Return `true` to keep the warning, `false` to discard it.
*/ */
warningFilter?: (warning: Warning) => boolean; warningFilter?: (warning: Warning) => boolean;
/** Experimental options */ /**
* Experimental options
* @since 5.36
*/
experimental?: { experimental?: {
/** Allow `await` keyword in deriveds, template expressions, and the top level of components */ /**
* Allow `await` keyword in deriveds, template expressions, and the top level of components
* @since 5.36
*/
async?: boolean; async?: boolean;
}; };
} }

@ -526,6 +526,7 @@ export async function tick() {
* Returns a promise that resolves once any state changes, and asynchronous work resulting from them, * Returns a promise that resolves once any state changes, and asynchronous work resulting from them,
* have resolved and the DOM has been updated * have resolved and the DOM has been updated
* @returns {Promise<void>} * @returns {Promise<void>}
* @since 5.36
*/ */
export function settled() { export function settled() {
return Batch.ensure().settled(); return Batch.ensure().settled();

@ -528,7 +528,8 @@ declare module 'svelte' {
/** /**
* Returns a promise that resolves once any state changes, and asynchronous work resulting from them, * Returns a promise that resolves once any state changes, and asynchronous work resulting from them,
* have resolved and the DOM has been updated * have resolved and the DOM has been updated
* */ * @since 5.36
*/
export function settled(): Promise<void>; export function settled(): Promise<void>;
/** /**
* When used inside a [`$derived`](https://svelte.dev/docs/svelte/$derived) or [`$effect`](https://svelte.dev/docs/svelte/$effect), * 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' {
* Use this to filter out warnings. Return `true` to keep the warning, `false` to discard it. * Use this to filter out warnings. Return `true` to keep the warning, `false` to discard it.
*/ */
warningFilter?: (warning: Warning) => boolean; warningFilter?: (warning: Warning) => boolean;
/** Experimental options */ /**
* Experimental options
* @since 5.36
*/
experimental?: { experimental?: {
/** Allow `await` keyword in deriveds, template expressions, and the top level of components */ /**
* Allow `await` keyword in deriveds, template expressions, and the top level of components
* @since 5.36
*/
async?: boolean; async?: boolean;
}; };
} }
@ -3031,9 +3038,15 @@ declare module 'svelte/types/compiler/interfaces' {
* Use this to filter out warnings. Return `true` to keep the warning, `false` to discard it. * Use this to filter out warnings. Return `true` to keep the warning, `false` to discard it.
*/ */
warningFilter?: (warning: Warning_1) => boolean; warningFilter?: (warning: Warning_1) => boolean;
/** Experimental options */ /**
* Experimental options
* @since 5.36
*/
experimental?: { experimental?: {
/** Allow `await` keyword in deriveds, template expressions, and the top level of components */ /**
* Allow `await` keyword in deriveds, template expressions, and the top level of components
* @since 5.36
*/
async?: boolean; async?: boolean;
}; };
} }

Loading…
Cancel
Save