chore: add `@description` tags (#12063)

add them so that the TypeScript parser doesn't put the following content under the `@deprecated` tag, which messes with the JSON-type-generation script.
pull/12072/head
Simon H 6 months ago committed by GitHub
parent 4ddff6f9d0
commit 8388c4d90e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -170,6 +170,7 @@ export class SvelteComponentTyped<
/**
* @deprecated The new `Component` type does not have a dedicated Events type. Use `ComponentProps` instead.
*
* @description
* Convenience type to get the events the given component expects. Example:
* ```html
* <script lang="ts">
@ -208,6 +209,7 @@ export type ComponentProps<Comp extends SvelteComponent | Component<any>> =
/**
* @deprecated This type is obsolete when working with the new `Component` type.
*
* @description
* Convenience type to get the type of a Svelte component. Useful for example in combination with
* dynamic components using `<svelte:component>`.
*

@ -167,6 +167,7 @@ declare module 'svelte' {
/**
* @deprecated The new `Component` type does not have a dedicated Events type. Use `ComponentProps` instead.
*
* @description
* Convenience type to get the events the given component expects. Example:
* ```html
* <script lang="ts">
@ -205,6 +206,7 @@ declare module 'svelte' {
/**
* @deprecated This type is obsolete when working with the new `Component` type.
*
* @description
* Convenience type to get the type of a Svelte component. Useful for example in combination with
* dynamic components using `<svelte:component>`.
*

Loading…
Cancel
Save