Skip to content

fix(types): fix generics for refetchPage function #2638

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

Merged
TkDodo merged 1 commit into from
Sep 18, 2021
Merged

fix(types): fix generics for refetchPage function #2638

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
24 changes: 12 additions & 12 deletions src/core/queryClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,13 +184,13 @@ export class QueryClient {
})
}

resetQueries(
filters?: ResetQueryFilters,
resetQueries<TPageData = unknown>(
filters?: ResetQueryFilters<TPageData>,
options?: ResetOptions
): Promise<void>
resetQueries(
resetQueries<TPageData = unknown>(
queryKey?: QueryKey,
filters?: ResetQueryFilters,
filters?: ResetQueryFilters<TPageData>,
options?: ResetOptions
): Promise<void>
resetQueries(
Expand Down Expand Up @@ -238,13 +238,13 @@ export class QueryClient {
return Promise.all(promises).then(noop).catch(noop)
}

invalidateQueries(
filters?: InvalidateQueryFilters,
invalidateQueries<TPageData = unknown>(
filters?: InvalidateQueryFilters<TPageData>,
options?: InvalidateOptions
): Promise<void>
invalidateQueries(
invalidateQueries<TPageData = unknown>(
queryKey?: QueryKey,
filters?: InvalidateQueryFilters,
filters?: InvalidateQueryFilters<TPageData>,
options?: InvalidateOptions
): Promise<void>
invalidateQueries(
Expand All @@ -270,13 +270,13 @@ export class QueryClient {
})
}

refetchQueries(
filters?: RefetchQueryFilters,
refetchQueries<TPageData = unknown>(
filters?: RefetchQueryFilters<TPageData>,
options?: RefetchOptions
): Promise<void>
refetchQueries(
refetchQueries<TPageData = unknown>(
queryKey?: QueryKey,
filters?: RefetchQueryFilters,
filters?: RefetchQueryFilters<TPageData>,
options?: RefetchOptions
): Promise<void>
refetchQueries(
Expand Down
4 changes: 2 additions & 2 deletions src/core/queryObserver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,8 +275,8 @@ export class QueryObserver<
this.client.getQueryCache().remove(this.currentQuery)
}

refetch(
options?: RefetchOptions & RefetchQueryFilters<TData>
refetch<TPageData>(
options?: RefetchOptions & RefetchQueryFilters<TPageData>
): Promise<QueryObserverResult<TData, TError>> {
return this.fetch({
...options,
Expand Down
22 changes: 11 additions & 11 deletions src/core/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,32 +236,32 @@ export interface ResultOptions {
throwOnError?: boolean
}

export interface RefetchPageFilters<TQueryFnData = unknown> {
export interface RefetchPageFilters<TPageData = unknown> {
refetchPage?: (
lastPage: TQueryFnData,
lastPage: TPageData,
index: number,
allPages: TQueryFnData[]
allPages: TPageData[]
) => boolean
}

export interface RefetchOptions extends ResultOptions {
cancelRefetch?: boolean
}

export interface InvalidateQueryFilters<TQueryFnData = unknown>
export interface InvalidateQueryFilters<TPageData = unknown>
extends QueryFilters,
RefetchPageFilters<TQueryFnData> {
RefetchPageFilters<TPageData> {
refetchActive?: boolean
refetchInactive?: boolean
}

export interface RefetchQueryFilters<TQueryFnData = unknown>
export interface RefetchQueryFilters<TPageData = unknown>
extends QueryFilters,
RefetchPageFilters<TQueryFnData> {}
RefetchPageFilters<TPageData> {}

export interface ResetQueryFilters<TQueryFnData = unknown>
export interface ResetQueryFilters<TPageData = unknown>
extends QueryFilters,
RefetchPageFilters<TQueryFnData> {}
RefetchPageFilters<TPageData> {}

export interface InvalidateOptions {
throwOnError?: boolean
Expand Down Expand Up @@ -299,8 +299,8 @@ export interface QueryObserverBaseResult<TData = unknown, TError = unknown> {
isRefetchError: boolean
isStale: boolean
isSuccess: boolean
refetch: (
options?: RefetchOptions & RefetchQueryFilters<TData>
refetch: <TPageData>(
options?: RefetchOptions & RefetchQueryFilters<TPageData>
) => Promise<QueryObserverResult<TData, TError>>
remove: () => void
status: QueryStatus
Expand Down