fix(core): correct useCustom return type to allow undefined data (fixes #7088)#7161
Open
harikapadia999 wants to merge 3 commits intorefinedev:mainfrom
Open
fix(core): correct useCustom return type to allow undefined data (fixes #7088)#7161harikapadia999 wants to merge 3 commits intorefinedev:mainfrom
harikapadia999 wants to merge 3 commits intorefinedev:mainfrom
Conversation
The useCustom hook's result.data type was incorrectly typed as always defined, causing TypeScript errors when trying to use optional chaining or check for undefined. Changes: - Updated UseCustomReturnType to explicitly allow undefined for result.data - Added comprehensive JSDoc explaining when data can be undefined - Removed EMPTY_OBJECT fallback that masked the undefined state - Now correctly returns undefined during loading, errors, or disabled queries This fix aligns the TypeScript types with the actual runtime behavior, preventing type errors and enabling proper null-safety checks. Fixes refinedev#7088
…ed handling Add extensive test coverage for the bug fix in refinedev#7088: - Test that result.data is undefined during loading state - Test that result.data is undefined when query hasn't executed - Test that result.data is undefined on error - Test TypeScript type safety with undefined checks - Test edge cases with empty responses and null data - Test transition from undefined to defined state These tests ensure the type fix correctly reflects runtime behavior and prevents regressions.
🦋 Changeset detectedLatest commit: d65825e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
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
1 participant
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.
Description
Fixes #7088
The
useCustomhook'sresult.datatype was incorrectly typed as always defined, causing TypeScript errors when using optional chaining or checking for undefined values.Changes
Type System
UseCustomReturnTypeto explicitly markresult.dataasTData | undefinedEMPTY_OBJECTfallback that masked the undefined stateRuntime Behavior
undefinedforresult.dataduring:enabled: false)Testing
Impact
✅ Enables proper null-safety checks - Users can now safely use optional chaining
✅ Aligns types with runtime - TypeScript types now match actual behavior
✅ Backward compatible - Existing code continues to work
✅ Better DX - No more type errors for correct code
Example
Before (Type Error):
After (Works Correctly):