refactor(usePrevious): remove undefined from compare argument and return type#272
Open
refactor(usePrevious): remove undefined from compare argument and return type#272
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the usePrevious hook to remove undefined from both the compare function's argument types and the return type, making the type definitions more accurate to reflect the actual behavior where the hook always returns a value of type T.
- Updated type signatures to remove
undefinedfrom compare function parameter and return type - Updated documentation in both English and Korean to reflect the corrected types
- Modified the default comparison function to match the new type signature
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/hooks/usePrevious/usePrevious.ts | Updated type signatures and JSDoc comments to remove undefined types |
| src/hooks/usePrevious/usePrevious.md | Updated documentation interface to reflect corrected types |
| src/hooks/usePrevious/ko/usePrevious.md | Updated Korean documentation interface to reflect corrected types |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #272 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 37 37
Lines 1093 1093
Branches 324 324
=========================================
Hits 1093 1093 🚀 New features to boost your workflow:
|
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.
Overview
This PR updates both the code and documentation for the
usePrevioushook to removeundefinedfrom thecomparefunction's argument types and from the return type.Since the state parameter passed to the hook is a required value and always provided, and the initial
stateis stored inprevRef, the prev argument never becomes undefined during the hook's lifecycle. Thus, the hook also never returnsundefined.This update ensures consistency between implementation, type definitions, and documentation, clarifying the intended usage.
Checklist
yarn run fixto format and lint the code and docs?yarn run test:coverageto make sure there is no uncovered line?