diff --git a/.changeset/fifty-buckets-return.md b/.changeset/fifty-buckets-return.md new file mode 100644 index 000000000000..7c79f0b596bb --- /dev/null +++ b/.changeset/fifty-buckets-return.md @@ -0,0 +1,5 @@ +--- +'svelte': patch +--- + +correct the suggested type for custom events without detail diff --git a/packages/svelte/src/index-client.js b/packages/svelte/src/index-client.js index fd8e999da763..efd5628ae951 100644 --- a/packages/svelte/src/index-client.js +++ b/packages/svelte/src/index-client.js @@ -114,7 +114,7 @@ function create_custom_event(type, detail, { bubbles = false, cancelable = false * The event dispatcher can be typed to narrow the allowed event names and the type of the `detail` argument: * ```ts * const dispatch = createEventDispatcher<{ - * loaded: never; // does not take a detail argument + * loaded: null; // does not take a detail argument * change: string; // takes a detail argument of type string, which is required * optional: number | null; // takes an optional detail argument of type number * }>(); diff --git a/packages/svelte/types/index.d.ts b/packages/svelte/types/index.d.ts index 6f12daf18778..8fc174b0a944 100644 --- a/packages/svelte/types/index.d.ts +++ b/packages/svelte/types/index.d.ts @@ -381,7 +381,7 @@ declare module 'svelte' { * The event dispatcher can be typed to narrow the allowed event names and the type of the `detail` argument: * ```ts * const dispatch = createEventDispatcher<{ - * loaded: never; // does not take a detail argument + * loaded: null; // does not take a detail argument * change: string; // takes a detail argument of type string, which is required * optional: number | null; // takes an optional detail argument of type number * }>();