fix: type RenderHookOptions.wrapper with preact ComponentChildren#82
Open
akselinurmio wants to merge 1 commit into
Open
fix: type RenderHookOptions.wrapper with preact ComponentChildren#82akselinurmio wants to merge 1 commit into
akselinurmio wants to merge 1 commit into
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
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.
Summary
Fixes #81.
RenderHookOptions.wrapperwas typed asComponentType<{ children: Element }>. HereElementresolves to the DOMElementglobal rather than a preact/JSX type, so a normal wrapper component (context providers, etc.) typed withComponentChildren/PropsWithChildrenis not assignable, producing a TS2322 error at everyrenderHookcall that passes awrapper.This changes the type to
ComponentType<{ children?: ComponentChildren }>, using preact'sComponentChildrenand makingchildrenoptional, matching how wrapper components are actually typed.Changes
ComponentChildrenfrompreact.wrapper?: ComponentType<{ children: Element }>→wrapper?: ComponentType<{ children?: ComponentChildren }>.Testing
npm test— 13 suites / 104 tests pass.npm run build— CJS + ESM compile successfully.The change is type-only; no runtime code changed.