fix: fix the type of the argument of KeyedMutator for populateCache
#2933
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
| <Data = any, MutationData = Data>( | ||
| key: Arguments, | ||
| data?: T | Promise<T> | MutatorCallback<T>, | ||
| opts?: boolean | MutatorOptions<Data, T> | ||
| ): Promise<T | undefined> | ||
| data?: MutationData | Promise<MutationData> | MutatorCallback<MutationData>, | ||
| opts?: boolean | MutatorOptions<Data, MutationData> | ||
| ): Promise<MutationData | undefined> |
There was a problem hiding this comment.
This is just refactoring for name consistency.
Since there is @typeParam MutationData comment docs, I think the generics parameter T should follow that.
|
Sure! If you want to modify my PR, please do at your mercy. |
|
Sorry, I didn't notice that some tests were unpassed. |
…lateCache`" This reverts commit d2a4282.
…ue of different value is assigned to mutate issue: vercel#2975
fix and add test
|
A PR I submitted fails some tests, so I've changed almost of whole things and add tests. I changed the type This achieves strict type attaching. |
| | MutatorCallback<Data[]>, | ||
| opts?: undefined | boolean | SWRInfiniteMutatorOptions<Data[], T> | ||
| ) { | ||
| function (data?: any, opts?: any) { |
There was a problem hiding this comment.
I request you for comments for attaching any type to the arguments.
The reason for attachching any is below.
I thought the type of the arguments data and opts should be any when using function overload since signatures in KeyedMutator couldn't be distinguished at this point.
The type of data argument at this point should be Data | Promise<Data | undefined> | MutatorCallback<Data>| MutationData | Promise<MutationData | undefined> | MutatorCallback<MutationData> | undefined.
But I I do so and pass the data to swr.mutate, It gives the following error.
No overload matches this call.
Overload 1 of 2, '(data?: Data[] | Promise<Data[] | undefined> | MutatorCallback<Data[]> | undefined, opts?: boolean | MutatorOptions<Data[], Data[]> | undefined): Promise<...>', gave the following error.
Argument of type 'Data[] | MutationData | Promise<Data[] | undefined> | MutatorCallback<Data[]> | Promise<MutationData | undefined> | MutatorCallback<...> | undefined' is not assignable to parameter of type 'Data[] | Promise<Data[] | undefined> | MutatorCallback<Data[]> | undefined'.
Type 'MutationData' is not assignable to type 'Data[] | Promise<Data[] | undefined> | MutatorCallback<Data[]> | undefined'.
Type 'MutationData' is not assignable to type 'Promise<Data[] | undefined>'.
Overload 2 of 2, '(data: MutationData | Promise<MutationData | undefined> | MutatorCallback<MutationData>, opts: Omit<...> & { ...; }): Promise<...>', gave the following error.
Argument of type 'Data[] | MutationData | Promise<Data[] | undefined> | MutatorCallback<Data[]> | Promise<MutationData | undefined> | MutatorCallback<...> | undefined' is not assignable to parameter of type 'MutationData | Promise<MutationData | undefined> | MutatorCallback<MutationData>'.
Type 'undefined' is not assignable to type 'MutationData | Promise<MutationData | undefined> | MutatorCallback<MutationData>'.ts(2769)
If I could know the type of Data at this point, I can avoid attaching any by comparing the type of Data with MutationData at runtime.
Do you know how to solve this?
I'm waiting for any comments and advices.
There was a problem hiding this comment.
My idea for how to solve this problem.
- use any
- tell the callback function about the type of
Dataand compare it like the following code
// this is invalid code, just for sharing my idea
if (typeof Data === typeof MutationData){
} else {
...
}- soft type attaching like the following code
const mutate = useCallback<SWRInfiniteKeyedMutator<Data[]>>(
// eslint-disable-next-line func-names
function <MutationData = Data[]>(
data?:
| Data
| Promise<Data | undefined>
| MutatorCallback<Data>
| MutationData
| Promise<MutationData | undefined>
| MutatorCallback<MutationData>
| undefined,
opts?: boolean | SWRInfiniteMutatorOptions<Data[], MutationData>
): Promise<Data[] | MutationData | undefined> {
// contents
return arguments.length
? swr.mutate<Data[]>(
data as any,
{
...options,
revalidate: shouldRevalidate
} as any
)
: swr.mutate()
},
// swr.mutate is always the same reference
// eslint-disable-next-line react-hooks/exhaustive-deps
[infiniteKey, cache]
)
closes #2975
What this PR does
This PR fixes a type error problem related to
populateCacheand boundmutate.Now, the first argument of bound
mutateonly accepts the type of the returned value offetcherbyuseSWR.But in order to make use of
populateCache, the first argument ofmutateshould accept any type of API fetching result.So I changed the type of the first argument from
Data(which is the type of datauseSWRfetches) intoMutationData(which is the type of the data returned by the mutator)In addition, I changed types in
infinitesince it had error when I changed the type ofKeyedMutator.