fix: update onMount type to allow async to return any #8714
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.
Building off #8136, the current type
onMount
definition is a bit unfriendly in VS Code tooltip. There was also an additional concern by dummdidumm prior to it being merged: #8136 (comment)This updated type definition solves both of these concerns:
This does also mean that explicitly typecasting a
function
intoany
will be allowed, but as per Conduitry's comments on the matter #8136 (comment):It's not a big problem to allow explicit opt-outs anyway.
I have opted to not add a changelog entry, because the current breaking change entry pointing to #8136 is very much still adequate to cover the changes from this PR. This PR technically even loosens the type definition to allow
any
-returning async functions inside onMount.Before submitting the PR, please make sure you do the following
feat:
,fix:
,chore:
, ordocs:
.Tests
pnpm test
and lint the project withpnpm lint