fix: useLocalStorage overload for correct undefined behavior #2556
+13
−3
Conversation
This file contains 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
Fixes streamich#2551 Instead of using a single function which accepts `defaultValue?: T` - which forces a return type of `T | undefined`, use an overload. When a defaultValue is supplied, the useState-like tuple returned uses `T`. When no defaultValue is supplied, it's `T | undefined`. Runtime usage is exaclty the same, this just improves the types.
Calvein
approved these changes
Jul 23, 2024
jamesmstone
reviewed
Aug 2, 2024
jamesmstone
approved these changes
Aug 2, 2024
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.
Fixes #2551
Instead of using a single function which accepts
defaultValue?: T- which forces a return type ofT | undefined, use an overload. When a defaultValue is supplied, the useState-like tuple returned usesT. When no defaultValue is supplied, it'sT | undefined.Runtime usage is exaclty the same, this just improves the types.
TypeScript playground demo of the bug and the fix.
Type of change
Checklist
Note: I tested this in my
node_modulesfolder and the typescript playground, but I pasted into the GitHub web UI, so I'm hoping that CI will catch any regressions. If anything goes red I'll clone locally and fix.yarn test)yarn lint). Fix it withyarn lint:fixin case of failure.yarn lint:types).