remove `ComponentEvent`

pull/7702/head
Ivan Hofer 4 years ago
parent 554dfbe134
commit 2bb594857a

@ -264,18 +264,18 @@ export class SvelteComponentTyped<
/**
* Convenience type to get the type of a Svelte component. Useful for example in combination with
* dynamic components using `<svelte:component>`.
*
*
* Example:
* ```html
* <script lang="ts">
* import type { ComponentType, SvelteComponentTyped } from 'svelte';
* import Component1 from './Component1.svelte';
* import Component2 from './Component2.svelte';
*
*
* const component: ComponentType = someLogic() ? Component1 : Component2;
* const componentOfCertainSubType: ComponentType<SvelteComponentTyped<{ needsThisProp: string }>> = someLogic() ? Component1 : Component2;
* </script>
*
*
* <svelte:component this={component} />
* <svelte:component this={componentOfCertainSubType} needsThisProp="hello" />
* ```
@ -292,7 +292,7 @@ export type ComponentType<Component extends SvelteComponentTyped = SvelteCompone
* <script lang="ts">
* import type { ComponentProps } from 'svelte';
* import Component from './Component.svelte';
*
*
* const props: ComponentProps<Component> = { foo: 'bar' }; // Errors if these aren't the correct props
* </script>
* ```
@ -308,36 +308,17 @@ export type ComponentProps<Component extends SvelteComponent> = Component extend
* import type { ComponentEvents } from 'svelte';
* import Component from './Component.svelte';
*
* type $$Events = ComponentEvents<Component>;
* function handleCloseEvent(event: ComponentEvents<Component>['close']) {
* console.log(event.detail);
* };
* </script>
*
* <div class="wrapper">
* <Component on:close />
* </div>
*
* <Component on:close={handleCloseEvent} />
* ```
*/
export type ComponentEvents<Component extends SvelteComponent> =
Component extends SvelteComponentTyped<any, infer Events> ? Events : never;
/**
* 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: ComponentEvent<Component, 'close'>) {
* 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 function loop_guard(timeout) {
const start = Date.now();
return () => {

Loading…
Cancel
Save