Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feat] add convenience type for ComponentEvents #7702

Merged
merged 12 commits into from Jul 25, 2022
2 changes: 1 addition & 1 deletion generate-type-definitions.js
Expand Up @@ -16,7 +16,7 @@ function modify(path, modifyFn) {

modify(
'types/runtime/index.d.ts',
content => content.replace('SvelteComponentTyped', 'SvelteComponentTyped, ComponentType, ComponentConstructorOptions, ComponentProps')
content => content.replace('SvelteComponentTyped', 'SvelteComponentTyped, ComponentType, ComponentConstructorOptions, ComponentProps, ComponentEvents, ComponentEvent, ComponentSlots')
ivanhofer marked this conversation as resolved.
Show resolved Hide resolved
);
modify(
'types/compiler/index.d.ts',
Expand Down
42 changes: 42 additions & 0 deletions src/runtime/internal/dev.ts
Expand Up @@ -301,6 +301,48 @@ export type ComponentProps<Component extends SvelteComponent> = Component extend
? Props
: never;

/**
* Convenience type to get the events the given component expects. Example:
* ```html
* <script lang="ts">
* import type { ComponentEvents } from 'svelte';
* import Component from './Component.svelte';
*
* type $$Events = ComponentEvent<Component>;
ivanhofer marked this conversation as resolved.
Show resolved Hide resolved
* </script>
*
* <div class="wrapper">
* <Component on:close />
* </div>
* ```
*/
export type ComponentEvents<Component extends SvelteComponent> = Component extends SvelteComponentTyped<any, infer Events>
? Events
: never;
ivanhofer marked this conversation as resolved.
Show resolved Hide resolved

/**
* Convenience type to get an event the given component expects. Example:
* ```html
* <script lang="ts">
* import type { ComponentEvent } from 'svelte';
* import Component from './Component.svelte';
*
* function handleCloseEvent(event: ComponentEvents<Component, 'close'>) {
ivanhofer marked this conversation as resolved.
Show resolved Hide resolved
* console.log(event.detail);
* };
* </script>
*
* <Component on:close={handleCloseEvent} />
* ```
*/
export type ComponentEvent<Component extends SvelteComponent, Name extends string> = Component extends SvelteComponentTyped<any, infer Events>
? never extends Events[Name] ? CustomEvent<unknown> : Events[Name]
: never;

export type ComponentSlots<Component extends SvelteComponent> = Component extends SvelteComponentTyped<any, any, infer Slots>
ivanhofer marked this conversation as resolved.
Show resolved Hide resolved
? {} extends Slots ? never : Slots
: never;

export function loop_guard(timeout) {
const start = Date.now();
return () => {
Expand Down