docs: Switch typing of Action<Parameter> from null to undefined in 12-use.md #14798
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.
Currently, the docs for
use:
give an example of using theAction
interface to type an action. In it,null
is specified as the optional type argument for the parameter. Unfortunately, this means the example leads to the following type error in practice, on the line whereuse:gestures
is contained:Expected 2 arguments, but got 1.
The solution is to switch the type argument for the parameter to
undefined
. This gets rid of the type error, accomplishes the intended behaviour, and matches the default value for the generic to begin with.No testing required as it is a documentation change. To recreate the type error simply copy and paste the example into any svelte project. I couldn't figure out how to get the playground compiler to do type-checking in svelte files to show it directly, or if it's even possible.