Skip to content

Commit 2417515

Browse files
committed
Updating docs
1 parent 343171b commit 2417515

1 file changed

Lines changed: 6 additions & 59 deletions

File tree

README.md

Lines changed: 6 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,25 @@
11
## useQuery(...) ✅
22

3-
### Result
4-
5-
- [x] `status: String`
6-
- [x] `isIdle: boolean`
7-
- [x] `isLoading: boolean`
8-
- [x] `isSuccess: boolean`
9-
- [x] `isError: boolean`
10-
- [x] `isLoadingError: boolean`
11-
- [x] `isRefetchError: boolean`
12-
- [x] `data: TData`
13-
- [x] `dataUpdatedAt: number`
14-
- [x] `error: null | TError`
15-
- [x] `errorUpdatedAt: number`
16-
- [x] `isStale: boolean`
17-
- [x] `isPlaceholderData: boolean`
18-
- [x] `isPreviousData: boolean`
19-
- [x] `isFetched: boolean`
20-
- [x] `isFetchedAfterMount: boolean`
21-
- [x] `isFetching: boolean`
22-
- [x] `failureCount: number`
23-
- [x] `refetch: (options: { throwOnError: boolean, cancelRefetch: boolean }) => Promise<UseQueryResult>`
24-
- [x] `remove: () => void`
25-
26-
### Options
27-
28-
- [x] `queryKey: string | unknown[]`
29-
- [x] `queryFn: (context: QueryFunctionContext) => Promise<TData>`
30-
- [x] `enabled: boolean`
31-
- [x] `retry: boolean | number | (failureCount: number, error: TError) => boolean`
32-
- [x] `retryOnMount: boolean`
33-
- [x] `retryDelay: number | (retryAttempt: number, error: TError) => number`
34-
- [x] `staleTime: number | Infinity`
35-
- [x] `cacheTime: number | Infinity`
36-
- [x] `queryKeyHashFn: (queryKey: QueryKey) => string`
37-
- [x] `refetchInterval: false | number`
38-
- [x] `refetchIntervalInBackground: boolean`
39-
- [x] `refetchOnMount: boolean | "always"`
40-
- [x] `refetchOnWindowFocus: boolean | "always"`
41-
- [x] `refetchOnReconnect: boolean | "always"`
42-
- [x] `notifyOnChangeProps: string[] | "tracked"`
43-
- [x] `notifyOnChangePropsExclusions: string[]`
44-
- [x] `onSuccess: (data: TData) => void`
45-
- [x] `onError: (error: TError) => void`
46-
- [x] `onSettled: (data?: TData, error?: TError) => void`
47-
- [x] `select: (data: TData) => unknown`
48-
- [x] `suspense: boolean`
49-
- [x] `initialData: TData | () => TData`
50-
- [x] `initialDataUpdatedAt: number | (() => number | undefined)`
51-
- [x] `placeholderData: TData | () => TData`
52-
- [x] `keepPreviousData: boolean`
53-
- [x] `structuralSharing: boolean`
54-
- [x] `useErrorBoundary: boolean`
55-
563
## useQueries(...) ✅
574

585
## Features
596

607
- useQuery ✅
618
- useQueries ✅
9+
- useMutation ✅
6210
- useInfiniteQuery
63-
- useMutation
64-
- useIsFetching
65-
- useIsMutating
66-
- QueryClient
67-
- QueryClientProvider
6811
- useQueryClient
12+
- useQueryErrorResetBoundary ✅
13+
- useIsFetching ✅
14+
- useIsMutating ✅
15+
- QueryClientProvider ✅
16+
- QueryClient
6917
- QueryCache
7018
- MutationCache
7119
- QueryObserver
7220
- InfiniteQueryObserver
7321
- QueriesObserver
7422
- QueryErrorResetBoundary
75-
- useQueryErrorResetBoundary
7623
- focusManager
7724
- onlineManager
7825
- setLogger

0 commit comments

Comments
 (0)