Skip to content

fix(query-core): infer setQueriesData data type from query filters #10834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
raashish1601 wants to merge 1 commit into from
+29 −3
Closed

fix(query-core): infer setQueriesData data type from query filters #10834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/query-core/src/__tests__/queryClient.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,15 +293,15 @@ describe('fully typed usage', () => {
>()
expectTypeOf(queryData3).toEqualTypeOf<TData | undefined>()

const queriesData2 = queryClient.setQueriesData(queryFilters, { foo: '' }) // TODO: types here are wrong and coming up undefined
const queriesData2 = queryClient.setQueriesData(queryFilters, { foo: '' })
type SetQueriesDataUpdaterArg = Parameters<
typeof queryClient.setQueriesData<unknown, typeof queryFilters>
>[1]

expectTypeOf<SetQueriesDataUpdaterArg>().toEqualTypeOf<
Updater<unknown, unknown>
>()
expectTypeOf(queriesData2).toEqualTypeOf<Array<[QueryKey, unknown]>>()
expectTypeOf(queriesData2).toEqualTypeOf<Array<[QueryKey, TData | undefined]>>()

const queryState = queryClient.getQueryState(filterKey)
expectTypeOf(queryState).toEqualTypeOf<
Expand Down Expand Up @@ -432,7 +432,7 @@ describe('fully typed usage', () => {
>()
expectTypeOf(queryData3).toEqualTypeOf<unknown>()

const queriesData2 = queryClient.setQueriesData(queryFilters, { foo: '' }) // TODO: types here are wrong and coming up undefined
const queriesData2 = queryClient.setQueriesData(queryFilters, { foo: '' })
type SetQueriesDataUpdaterArg = Parameters<
typeof queryClient.setQueriesData<unknown, typeof queryFilters>
>[1]
Expand Down
26 changes: 26 additions & 0 deletions packages/query-core/src/queryClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ interface MutationDefaults {
defaultOptions: MutationOptions<any, any, any, any>
}

type QueryDataForFilters<TQueryFilters extends QueryFilters> =
TQueryFilters extends QueryFilters<infer TQueryKey>
? InferDataFromTag<unknown, TQueryKey>
: unknown

// CLASS

export class QueryClient {
Expand Down Expand Up @@ -206,6 +211,27 @@ export class QueryClient {
.setData(data, { ...options, manual: true })
}

setQueriesData<TQueryFilters extends QueryFilters<any>>(
filters: TQueryFilters,
updater: Updater<
NoInfer<QueryDataForFilters<TQueryFilters>> | undefined,
NoInfer<QueryDataForFilters<TQueryFilters>> | undefined
>,
options?: SetDataOptions,
): Array<
[QueryKey, QueryDataForFilters<TQueryFilters> | undefined]
>
setQueriesData<
TQueryFnData,
TQueryFilters extends QueryFilters<any> = QueryFilters,
>(
filters: TQueryFilters,
updater: Updater<
NoInfer<TQueryFnData> | undefined,
NoInfer<TQueryFnData> | undefined
>,
options?: SetDataOptions,
): Array<[QueryKey, TQueryFnData | undefined]>
setQueriesData<
TQueryFnData,
TQueryFilters extends QueryFilters<any> = QueryFilters,
Expand Down