fix(types): allow null as fetcher in PublicConfiguration - #4290
Draft
okxint wants to merge 1 commit into
Draft
Conversation
SWRConfiguration.fetcher previously typed as Fn | undefined, rejecting null.
Passing null is valid at runtime and disables fetching, but TypeScript would
error on useSWR("key", { fetcher: null }) and explicit SWRConfiguration
assignments. Adds | null to PublicConfiguration.fetcher to match the
existing null support in SWRHook positional overloads.
Fixes vercel#2888
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.
What
Adds
| nulltoPublicConfiguration.fetcherso passingnullas a fetcher via the config object is accepted by TypeScript.Why
Passing
nullas fetcher is a valid runtime pattern to disable fetching for a key. The positional overloads onSWRHookalready typed fetcher asFetcher | null, souseSWR("key", null)worked fine. ButPublicConfiguration.fetcherwas typed as justFn, causing type errors for the config-object pattern:Fix
Also adds a type test covering both patterns to prevent regression.
All 365 unit tests pass. Full
tsc --noEmitpasses.Fixes #2888