Troubleshooting : Type an untyped module #254
Conversation
|
Hey @sw-yx, Is there a problem with my code formatting? I made sure to follow all the necessary steps. It will be great if you could review the changes I made and point me in the right direction. Thanks in advance! |
|
@arvindcheenu this looks like a good start! what about typing a React library that exports components or hooks? |
docs/basic/troubleshooting/types.md
Outdated
| * Add the `declare` syntax for your desired module, say `my-untyped-module`– to the declaration file. | ||
| ```ts | ||
| // inside typedec.d.ts | ||
| declare module "my-untyped-module" |
There was a problem hiding this comment.
TIL that you can just do this without braces! Does it resolve every import to any?
There was a problem hiding this comment.
yup. its a stopgap; i'd like for us to go a liiiitle bit beyond just this
There was a problem hiding this comment.
@ferdaber you can easily do away with every untyped import by declare module '*'. Saves many lines of declare code but too hacky for my taste.
There was a problem hiding this comment.
yup. its a stopgap; i'd like for us to go a liiiitle bit beyond just this
Most of the hooks I use are either typed or custom made. So, I haven't encountered this problem yet.. I'll try to come up with some solution. Coz, it is gonna happen someday and I want to be ready for it.
There was a problem hiding this comment.
yup. ive done it 3-4 times but had to look it up every time. i shouldve taken the hint and put it in the cheatsheet!
There was a problem hiding this comment.
Woah, awesome stuff. We can add the lines 11-26 from your gist as an example for creating types for class components as a quick reference. This will also gel well with the previously stated troubleshooting steps.
There was a problem hiding this comment.
So, reviewing all that's been discussed, the hierarchical focus of topics in the troubleshooting section for this would be:
Working with Untyped Libraries
- The Lazy Way
- Using
declare module "*"
- Using
- The Hard Way
- With Hooks
useDarkMode()example with explanation
- With Components
RR6example [11-26] with explanation
- With Hooks
@sw-yx, Is this right or am I missing anything?
There was a problem hiding this comment.
yes sounds good! this will be a great help for others
There was a problem hiding this comment.
@sw-yx I've updated the docs and readme with the stuff we discussed, can you check and help solve the formatting problems?
There was a problem hiding this comment.
awesome! thank you so much, this works!! :) :) :)
Co-authored-by: swyx <shawnthe1@gmail.com>
Co-authored-by: swyx <shawnthe1@gmail.com>
Co-authored-by: swyx <shawnthe1@gmail.com>
Co-authored-by: swyx <shawnthe1@gmail.com>
Explained workarounds and possible solutions for typing an untyped React Hook or a React Component with Code Examples.
|
* Update README.md with Types Added changes to Troubleshooting types from #254 to README.md * Update README.md * fix prettier Co-authored-by: swyx <wanshawn@amazon.com>
Added Docs for Exporting types for Untyped libraries. PR for the Issue #245