Skip to content

refactor(query-core): Make MutationMeta and QueryMeta generic #5457

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
vojvodics wants to merge 2 commits into from
Closed

refactor(query-core): Make MutationMeta and QueryMeta generic #5457

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
309c3f5
refactor(query-core): Make MutationMeta and QueryMeta generic
vojvodics May 24, 2023
6928516
Merge branch 'alpha' into refactor/query-mutation-meta-generics
TkDodo May 26, 2023
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
28 changes: 23 additions & 5 deletions packages/query-core/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@ import type { QueryFilters, QueryTypeFilter } from './utils'
import type { QueryCache } from './queryCache'
import type { MutationCache } from './mutationCache'

export interface Register {
// @ts-expect-error unused arg
export interface Register<
TQueryFnDataOrTData = unknown,
TError = unknown,
TDataOrTVariables = unknown,
TQueryKeyOrTContext = unknown,
TPageParam = never,
> {
// defaultError: Error
// queryMeta: Record<string, unknown>
// mutationMeta: Record<string, unknown>
Expand Down Expand Up @@ -85,7 +92,13 @@ export interface InfiniteData<TData> {
pageParams: unknown[]
}

export type QueryMeta = Register extends {
export type QueryMeta<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = never,
> = Register<TQueryFnData, TError, TData, TQueryKey, TPageParam> extends {
queryMeta: infer TQueryMeta
}
? TQueryMeta extends Record<string, unknown>
Expand Down Expand Up @@ -132,7 +145,7 @@ export interface QueryOptions<
* Additional payload to be stored on each query.
* Use this property to pass information that can be used in other places.
*/
meta?: QueryMeta
meta?: QueryMeta<TQueryFnData, TError, TData, TQueryKey, TPageParam>
/**
* Maximum number of pages to store in the data of an infinite query.
*/
Expand Down Expand Up @@ -590,7 +603,12 @@ export type MutationKey = readonly unknown[]

export type MutationStatus = 'idle' | 'pending' | 'success' | 'error'

export type MutationMeta = Register extends {
export type MutationMeta<
TData = unknown,
TError = DefaultError,
TVariables = unknown,
TContext = unknown,
> = Register<TData, TError, TVariables, TContext> extends {
mutationMeta: infer TMutationMeta
}
? TMutationMeta
Expand Down Expand Up @@ -632,7 +650,7 @@ export interface MutationOptions<
networkMode?: NetworkMode
gcTime?: number
_defaulted?: boolean
meta?: MutationMeta
meta?: MutationMeta<TData, TError, TVariables, TContext>
}

export interface MutationObserverOptions<
Expand Down