fix type definition on useResizeObserver #326
Conversation
When using `useResizeObserver`, I discovered that the definition of the return type of this hook was misleading. `DOMRect` is initialized to `undefined`, and upon the first run of this hook, the return value can be undefined. In fact, the docs all show that you should check for the existence of `DOMRect` before doing anything with the return value. That should be reflected in the types.
|
I apologize, it looks like I didn't read the contribution guidelines closely enough. I forgot to update the version in package.json and changelog. Should I open a new PR to do that? |
|
@genepaul don't worry, it's not a problem... and if anything it's my bad :)) |
|
@genepaul version 1.0.4 containing your contribution has been released! Thank you very much for improving the project. |
|
@antonioru - I'm sorry to keep bothering you but it looks like the build wasn't run so my change isn't in 1.0.4 😦 |
|
@genepaul not bothering at all mate! Are you sure about that? |
|
I've created a brand new react project from scratch using create-react-app and installed |
|
You're right, my bad. My IDE wasn't updating with the TS types, but I see it. Thanks! |
|
@genepaul you're welcome |
Description
When using
useResizeObserver, I discovered that the definition of the return type of this hook was misleading.DOMRectis initialized toundefined, and upon the first run of this hook, the return value can be undefined. In fact, the docs all show that you should check for the existence ofDOMRectbefore doing anything with the return value. That should be reflected in the types.Related Issue
Fixes #325
Motivation and Context
TypeScript should be used to help consumers understand the potential values a variable could be. The return type of this function being inaccurate can cause consumers to inaccurately handle it and expect it to always be defined.
How Has This Been Tested?
Linked locally into my project using this function and verified that it correctly reported that it was potentially undefined.
Screenshots (if appropriate):