docs: wrap reset handler in useStopwatch example - #147
Open
OFK0 wants to merge 1 commit into
Open
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.
Closes #142
Problem
The README documents passing reset straight to an event handler:
<button onClick={reset}>Reset</button>Doing that throws at runtime:
TypeError: e2.getTime is not a function at getMillisecondsFromExpiryReact invokes click handlers with the MouseEvent as the first argument, and reset only checked that its offset parameter was truthy before handing it to
Time.getMillisecondsFromExpiry, which callsexpiry?.getTime(). A MouseEvent is truthy and has no getTime, so it blows up.The repo's own demo already worked around this with
onClick={() => reset()}, so the README was teaching a pattern the library could not support.Fix
Update the README stopwatch example to onClick={() => reset()}, matching the demo app.