-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(kit,schema): improve type safety of defineNuxtModule
options
#26850
Merged
+89
−28
Conversation
This file contains 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
Run & review this pull request in StackBlitz Codeflow. |
DamianGlowala
changed the title
feat(kit,schema): improve type inference in
feat(kit,schema): improve type safety in Apr 19, 2024
defineNuxtModule
defineNuxtModule
DamianGlowala
changed the title
feat(kit,schema): improve type safety in
feat(kit,schema): improve type safety of Apr 22, 2024
defineNuxtModule
defineNuxtModule
options
danielroe
approved these changes
Jun 10, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great!
I think we should add some docs to the module author guide. (Can be a subsequent PR.)
danielroe
added a commit
that referenced
this pull request
Jun 10, 2024
This reverts commit c06a683.
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.
🔗 Linked issue
📚 Description
Currently, defining the defaults for options in
defineNuxtModule
does not impact the type ofresolvedOptions
param within thesetup
function. Their types are disconnected, which this PR aims to address.As of today, TypeScript does not support partial inference of generic type params. Due to this fact, I'd like to suggest adding an extra function call (named
with
), which can handle merging inferred defaults with the module options generic type param and therefore improve both the type safety and DX:I put effort to add it in a non-breaking way. It would be good to double check nothing changed in the current implementation.