This repository was archived by the owner on Nov 25, 2022. It is now read-only.
Update preloadScript types with generics#170
Open
DogPawHat wants to merge 1 commit intoopentok:mainfrom
Open
Conversation
The `preloadScript` HOC passes down props other than described in `PreloadScriptProps` down to child components. Adds generics to reflect this behavior.
|
Hi OpenTok team - I'm working on a TypeScript migration on a react codebase and am running into this very issue. Thank you for considering this fix! |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Behavior of
preloadScript.jsExpected Typescript Behavior
The HOC take in a
InnerComponentand outputs a new Components with it's ownpropTypesbut also passes on any props not used by itself to the InnerComponent. Props outside ofPreloadScriptProps / PreloadScript.propTypesshould therefore comply with theInnerCompoentsprop type validation as well aspreloadScriptsProp types.Actual Typescript Behavior
Passing in props besides
PreloadScriptPropswill trigger a type checking error, contrary to the behavior allowed in vanilla JS. You therefore can't pass down props toInnerComponentin TS despite the JS code doing thatRemedy
Update the typing declarations for
preloadScriptto use generics to allow props to be passed down toInnerComponent