feat(kit,schema): improve type safety of defineNuxtModule
options
#26850
+89
−28
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.