From 3d9a9ab32d31a3a09794bffaead83b9043947dca Mon Sep 17 00:00:00 2001 From: Thor Galle Date: Thu, 17 Apr 2025 08:35:44 +0200 Subject: [PATCH] docs: correct the suggested type for custom events without detail (Svelte 4) (#15763) * docs: correct the suggested type for custom events without detail * docs: generate fixed types for the Svelte 4 event dispatcher --- .changeset/fifty-buckets-return.md | 5 +++++ packages/svelte/src/index-client.js | 2 +- packages/svelte/types/index.d.ts | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .changeset/fifty-buckets-return.md diff --git a/.changeset/fifty-buckets-return.md b/.changeset/fifty-buckets-return.md new file mode 100644 index 0000000000..7c79f0b596 --- /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 fd8e999da7..efd5628ae9 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 6f12daf187..8fc174b0a9 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 * }>();