docs: correct the suggested type for custom events without detail (Svelte 4) #15763
+7
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 15b66b5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
dummdidumm
reviewed
Apr 14, 2025
|
It was a very understandable oversight 🙂 And I didn't realize I had to generate the types, done now! |
|
dummdidumm
approved these changes
Apr 17, 2025
| 'svelte': patch | ||
| --- | ||
|
|
||
| correct the suggested type for custom events without detail |
There was a problem hiding this comment.
Suggested change
| correct the suggested type for custom events without detail | |
| fix: adjust suggested type for custom events without detail |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before submitting the PR, please make sure you do the following
feat:,fix:,chore:, ordocs:.packages/svelte/src, add a changeset (npx changeset).Tests and linting
pnpm testand lint the project withpnpm lintTests are OK, except for those using Playwright, which I didn't install. Linting crashes for me with an Eslint "Cannot find module" error. I'm holding off on fixing these setup issues, I'm not sure if it's worth it for a one-word docs change.
I tried to follow the guidance given by the docs for
createEventDispatcherto type a custom event without a detail argument. The function documentation mentions that thenevertype can be used for this. However, when doing this, I'm getting a Typescript errorExpected 2-3 arguments, but got 1when callingcreateEventDispatcher.I searched the dedicated v4 docs site and found this section on createEventDispatcher which includes
event: null; // does not accept a payload. I assume that "payload" & "detail" mean the same thing, and that suggesting to use "never" was a mistake in the function docs (or something that was never updated). With "null" it works as expected!