Open angelod1as opened 10 months ago
I've read through #939 and couldn't find an answer
Weirdly, this stops the error... but... why!????
const { data, error, isValidating } = useSWR(
shouldFetch ? { query, sessionToken } : null,
getInfo,
{}, // <---- I added this
)
These two issues are related https://github.com/vercel/swr/issues/2822
This started happening from release v2.2.3 from the removal of a type in #2759. Adding this back to the SWRHook interface or reverting to a version before v2.2.3 address the type error you got.
// type that was removed
<Data = any, Error = any>(
key: Key,
fetcher: BareFetcher<Data> | null
): SWRResponse<Data, Error>
Adding something ({} or undefined) after the fetcher makes the type fall onto one of the other overloads found in the SWRHook interface.
@jarangutan thanks for your input. That was the 'fix' I used, although it's far from a fix — before I had proper types for my response, now, if I add any types it throws the error, and if I use {}
I have zero types...
Fully agree on it being far from a fix. My response was mostly to add context on where this goof started happening for others.
And interesting :o
I was getting one of the interfaces with SWRConfiguration<Data, Error, Fetcher<Data, SWRKey>>
with my type added to it for the Response and Error whenever I added {} or undefined for the config partial after the fetcher. Are you saying you get no types if you add {} after the fetcher?
What typescript version are you using? I wonder if that's making a difference if you're getting no types adding the config.
type QUERY_KEY = {
query: string;
sessionToken: string;
}
// ...
const fetcher: Fetcher<Result, QUERY_KEY> = (key) => fetch(...)
// ...
const { data, error, isValidating } = useSWR(
{ query, sessionToken } as QUERY_KEY, // <-- add the type assertion
fetcher,
)
After adding type assertion, compiler stopped complaining and yarn build
success.
I also faced this error when upgrading nodejs from v18.15.0
to v18.19.0
. (yeah, I didn't touch my project). After that I ran yarn build
which then emitted this error.
I noticed that it only shows error when the key is NOT a literal type (string
for example). If it is an object like in the example, there's complaints.
Adding
{}
to the third argument ofuseSWR
fixed the issue
That's because you are trying to let the compiler thinks that you are overloading one of its "mutants".
Try adding the as Type
assertion to the key of the useSWR
hook (the first argument). It fixes the error.
This solves it, although I dislike type assertions.
Ikr, it used to "just works".
IMHO, that solution sounds more like a workaround, not a proper solution.
I'd recommend leave it open.
The SRW documentation says to do this (but it doesn't work)
const { data: user } = useSWR(['/api/user', token], ([url, token]) => fetchWithToken(url, token))
While in reality in this way it works
const fetchUser = async (url: string, id: string) => await getUser(id);
const { data, error } = useSWR('/api/users/${userId}', () => fetchUser('/api/users/${userId}', userId) );
with many params:
const fetchUserWithParam = async (url: string, id: string, myParam: string) => await getUser(id, myParam);
const { data, error } = useSWR( [ '/api/users/${userId}', myParam ], () => fetchUserWithParam('/api/users/${userId}', userId, myParam ) );
Bug report
Description / Observed Behavior
Updating the package, I have now some functions with typescript errors.
They throw
Type '({ query, sessionToken, }: Data) => Promise<ApiResponse>' has no properties in common with type 'Partial<PublicConfiguration<any, any, BareFetcher<any>>>'.
I am certainly doing something wrong, as some other functions work properly.
See Repro Steps for more details.
Expected Behavior
The function should not error or the docs should be clearer on how to set the correct types.
Repro Steps / Code Example
I tried with no luck
also::
If I add the function straight into the hook, no error is thrown:
If I cast the parameter as
any
it does not error anymore, e.g.:If I simplify it also doesn't work:
Just as a comparison: this works perfectly in my codebase:
Additional Context
SWR version:
"swr": "^2.2.4"