Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

suspense.ts

67 lines1.8 KB

1import type {
2 DefaultError,
3 DefaultedQueryObserverOptions,
4 Query,
5 QueryKey,
6 QueryObserver,
7 QueryObserverResult,
8} from '@tanstack/query-core'
9import type { QueryErrorResetBoundaryValue } from './QueryErrorResetBoundary'
10​
11export const defaultThrowOnError = <
12 TQueryFnData = unknown,
13 TError = DefaultError,
14 TData = TQueryFnData,
15 TQueryKey extends QueryKey = QueryKey,
16>(
17 _error: TError,
18 query: Query<TQueryFnData, TError, TData, TQueryKey>,
19) => query.state.data === undefined
20​
21export const ensureSuspenseTimers = (
22 defaultedOptions: DefaultedQueryObserverOptions<any, any, any, any, any>,
23) => {
24 if (defaultedOptions.suspense) {
25 // Always set stale time when using suspense to prevent
26 // fetching again when directly mounting after suspending
27 if (typeof defaultedOptions.staleTime !== 'number') {
28 defaultedOptions.staleTime = 1000
29 }
30 if (typeof defaultedOptions.gcTime === 'number') {
31 defaultedOptions.gcTime = Math.max(defaultedOptions.gcTime, 1000)
32 }
33 }
35​
36export const willFetch = (
37 result: QueryObserverResult<any, any>,
38 isRestoring: boolean,
39) => result.isLoading && result.isFetching && !isRestoring
40​
41export const shouldSuspend = (
42 defaultedOptions:
43 | DefaultedQueryObserverOptions<any, any, any, any, any>
44 | undefined,
45 result: QueryObserverResult<any, any>,
46) => defaultedOptions?.suspense && result.isPending
47​
48export const fetchOptimistic = <
49 TQueryFnData,
50 TError,
51 TData,
52 TQueryData,
53 TQueryKey extends QueryKey,
54>(
55 defaultedOptions: DefaultedQueryObserverOptions<
56 TQueryFnData,
57 TError,
58 TData,
59 TQueryData,
60 TQueryKey
61 >,
62 observer: QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>,
63 errorResetBoundary: QueryErrorResetBoundaryValue,
64) =>
65 observer.fetchOptimistic(defaultedOptions).catch(() => {
66 errorResetBoundary.clearReset()
67 })