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

useSuspenseInfiniteQuery.ts

51 lines1.3 KB

1'use client'
2import { InfiniteQueryObserver, skipToken } from '@tanstack/query-core'
3import { useBaseQuery } from './useBaseQuery'
4import { defaultThrowOnError } from './suspense'
5import type {
6 DefaultError,
7 InfiniteData,
8 InfiniteQueryObserverSuccessResult,
9 QueryClient,
10 QueryKey,
11 QueryObserver,
12} from '@tanstack/query-core'
13import type {
14 UseSuspenseInfiniteQueryOptions,
15 UseSuspenseInfiniteQueryResult,
16} from './types'
17​
18export function useSuspenseInfiniteQuery<
19 TQueryFnData,
20 TError = DefaultError,
21 TData = InfiniteData<TQueryFnData>,
22 TQueryKey extends QueryKey = QueryKey,
23 TPageParam = unknown,
24>(
25 options: UseSuspenseInfiniteQueryOptions<
26 TQueryFnData,
27 TError,
28 TData,
29 TQueryFnData,
30 TQueryKey,
31 TPageParam
32 >,
33 queryClient?: QueryClient,
34): UseSuspenseInfiniteQueryResult<TData, TError> {
35 if (process.env.NODE_ENV !== 'production') {
36 if (options.queryFn === skipToken) {
37 console.error('skipToken is not allowed for useSuspenseInfiniteQuery')
38 }
39 }
40​
41 return useBaseQuery(
42 {
43 ...options,
44 enabled: true,
45 suspense: true,
46 throwOnError: defaultThrowOnError,
47 },
48 InfiniteQueryObserver as typeof QueryObserver,
49 queryClient,
50 ) as InfiniteQueryObserverSuccessResult<TData, TError>