-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- split type file - add documentation about default options
- Loading branch information
1 parent
23c931c
commit 0581fcf
Showing
7 changed files
with
269 additions
and
137 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,128 +1,32 @@ | ||
| import { | ||
| CancelOptions, | ||
| FetchInfiniteQueryOptions, | ||
| FetchQueryOptions, | ||
| InfiniteData, | ||
| InvalidateOptions, | ||
| InvalidateQueryFilters, | ||
| QueryFunction, | ||
| QueryKey, | ||
| RefetchOptions, | ||
| RefetchQueryFilters, | ||
| ResetOptions, | ||
| ResetQueryFilters, | ||
| SetDataOptions, | ||
| QueryOptions, | ||
| UseInfiniteQueryOptions, | ||
| UseInfiniteQueryResult, | ||
| UseQueryOptions, | ||
| UseQueryResult, | ||
| } from "react-query"; | ||
| import { QueryState } from "react-query/types/core/query"; | ||
| import { QueryFilters, Updater } from "react-query/types/core/utils"; | ||
|
|
||
| export type QueryType = "query" | "infiniteQuery"; | ||
| export type TQueryFunction<TQueryFnArgs extends unknown[], TQueryFnReturn> = ( | ||
| ...args: TQueryFnArgs | ||
| ) => QueryFunction<TQueryFnReturn>; | ||
|
|
||
| interface QueryToolkitBase< | ||
| export type QueryDefaultOption< | ||
| TQueryFnData = unknown, | ||
| TError = unknown, | ||
| TData = TQueryFnData, | ||
| > { | ||
| getQueryData(queryKey?: QueryKey, filters?: QueryFilters): TData | undefined; | ||
| getQueryState( | ||
| queryKey?: QueryKey, | ||
| filters?: QueryFilters, | ||
| ): QueryState<TData, TError> | undefined; | ||
| setQueryData( | ||
| queryKey: QueryKey, | ||
| updater: Updater<TData | undefined, TData | undefined>, | ||
| options?: SetDataOptions, | ||
| ): TData; | ||
| getQueriesData(filters?: QueryFilters): [QueryKey, TData][]; | ||
| setQueriesData( | ||
| filters: QueryFilters, | ||
| updater: Updater<TData | undefined, TData | undefined>, | ||
| options?: SetDataOptions, | ||
| ): [QueryKey, TData][]; | ||
|
|
||
| invalidateQueries<TPageData = unknown>( | ||
| filters?: InvalidateQueryFilters<TPageData>, | ||
| options?: InvalidateOptions, | ||
| ): Promise<void>; | ||
| refetchQueries<TPageData = unknown>( | ||
| filters?: RefetchQueryFilters<TPageData>, | ||
| options?: RefetchOptions, | ||
| ): Promise<void>; | ||
| cancelQueries(filters?: QueryFilters, options?: CancelOptions): Promise<void>; | ||
| removeQueries(filters?: QueryFilters): void; | ||
| resetQueries<TPageData = unknown>( | ||
| filters?: ResetQueryFilters<TPageData>, | ||
| options?: ResetOptions, | ||
| ): Promise<void>; | ||
|
|
||
| isFetching(filters?: QueryFilters): number; | ||
| useIsFetching(filters?: QueryFilters): number; | ||
| } | ||
|
|
||
| export interface QueryToolkitQueryType< | ||
| TQueryFnArgs extends unknown[] = [], | ||
| TQueryFnData = unknown, | ||
| TError = unknown, | ||
| TData = TQueryFnData, | ||
| > extends QueryToolkitBase<TQueryFnData, TError, TData> { | ||
| fetchInfiniteQuery: undefined; | ||
| prefetchInfiniteQuery: undefined; | ||
| useInfiniteQuery: undefined; | ||
| fetchQuery<TReturn = TData>( | ||
| args: TQueryFnArgs, | ||
| options?: Omit<FetchQueryOptions<TQueryFnData, TError, TReturn>, "queryFn">, | ||
| ): Promise<TReturn>; | ||
| prefetchQuery( | ||
| args: TQueryFnArgs, | ||
| options?: Omit<FetchQueryOptions<TQueryFnData, TError>, "queryFn">, | ||
| ): Promise<void>; | ||
| useQuery<TReturn = TData>( | ||
| args: TQueryFnArgs, | ||
| options?: Omit<UseQueryOptions<TQueryFnData, TError, TReturn>, "queryFn">, | ||
| ): UseQueryResult<TReturn, TError>; | ||
| } | ||
| > = Omit<QueryOptions<TQueryFnData, TError, TData>, "queryKey" | "queryFn">; | ||
|
|
||
| export interface QueryToolkitInfiniteQueryType< | ||
| TQueryFnArgs extends unknown[] = [], | ||
| export type UseQueryDefaultOption< | ||
| TQueryFnData = unknown, | ||
| TError = unknown, | ||
| TData = TQueryFnData, | ||
| > extends QueryToolkitBase<TQueryFnData, TError, TData> { | ||
| fetchQuery: undefined; | ||
| prefetchQuery: undefined; | ||
| useQuery: undefined; | ||
| fetchInfiniteQuery<TReturn = TData>( | ||
| args: TQueryFnArgs, | ||
| options?: Omit< | ||
| FetchInfiniteQueryOptions<TQueryFnData, TError, TReturn>, | ||
| "queryFn" | ||
| >, | ||
| ): Promise<InfiniteData<TReturn>>; | ||
| prefetchInfiniteQuery( | ||
| args: TQueryFnArgs, | ||
| options?: Omit<FetchQueryOptions<TQueryFnData, TError>, "queryFn">, | ||
| ): Promise<void>; | ||
| useInfiniteQuery<TReturn = TData>( | ||
| args: TQueryFnArgs, | ||
| options?: Omit< | ||
| UseInfiniteQueryOptions<TQueryFnData, TError, TReturn>, | ||
| "queryFn" | ||
| >, | ||
| ): UseInfiniteQueryResult<TReturn, TError>; | ||
| } | ||
| TError = unknown, | ||
| > = Omit<UseQueryOptions<TQueryFnData, TError, TData>, "queryKey" | "queryFn">; | ||
|
|
||
| export type QueryToolkit< | ||
| TQueryFnArgs extends unknown[] = [], | ||
| export type UseInfiniteQueryDefaultOption< | ||
| TQueryFnData = unknown, | ||
| TError = unknown, | ||
| TData = TQueryFnData, | ||
| > = | ||
| | QueryToolkitQueryType<TQueryFnArgs, TQueryFnData, TError, TData> | ||
| | QueryToolkitInfiniteQueryType<TQueryFnArgs, TQueryFnData, TError, TData>; | ||
| TError = unknown, | ||
| > = Omit< | ||
| UseInfiniteQueryOptions<TQueryFnData, TError, TData>, | ||
| "queryKey" | "queryFn" | ||
| >; |
Oops, something went wrong.