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

suspense.ts

64 lines1.7 KB

1import type { DefaultError } from '@tanstack/query-core'
2import type {
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) => typeof query.state.data === 'undefined'
20​
21export const ensureStaleTime = (
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 }
32​
33export const willFetch = (
34 result: QueryObserverResult<any, any>,
35 isRestoring: boolean,
36) => result.isLoading && result.isFetching && !isRestoring
37​
38export const shouldSuspend = (
39 defaultedOptions:
40 | DefaultedQueryObserverOptions<any, any, any, any, any>
41 | undefined,
42 result: QueryObserverResult<any, any>,
43) => defaultedOptions?.suspense && result.isPending
44​
45export const fetchOptimistic = <
46 TQueryFnData,
47 TError,
48 TData,
49 TQueryData,
50 TQueryKey extends QueryKey,
51>(
52 defaultedOptions: DefaultedQueryObserverOptions<
53 TQueryFnData,
54 TError,
55 TData,
56 TQueryData,
57 TQueryKey
58 >,
59 observer: QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>,
60 errorResetBoundary: QueryErrorResetBoundaryValue,
61) =>
62 observer.fetchOptimistic(defaultedOptions).catch(() => {
63 errorResetBoundary.clearReset()
64 })