0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/angular/reference/interfaces/CreateInfiniteQueryOptions.md
Wonsuk Choi 9810709718
docs(angular-query-experimental): add JSDoc across the package (#11406)
* docs(angular-query-experimental): add JSDoc across the package and generate reference docs with TypeDoc

* docs(angular-query-experimental): address CodeRabbit review comments on JSDoc accuracy

* docs(angular-query-experimental): use 'changes' instead of 'narrows' for select's effect on TData
2026-09-06 12:12:24 +09:00

1.3 KiB

id title
CreateInfiniteQueryOptions CreateInfiniteQueryOptions

Defined in: types.ts:121

The options accepted by injectInfiniteQuery. Same as CreateBaseQueryOptions, minus suspense — which angular-query-experimental doesn't support, unlike react-query — extends InfiniteQueryObserverOptions from @tanstack/query-core for the infinite-query-specific options (getNextPageParam, initialPageParam, etc.).

Extends

  • OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "suspense">

Type Parameters

TQueryFnData

TQueryFnData = unknown

The type of a single page, as your queryFn resolves it.

TError

TError = DefaultError

The type of errors your queryFn may throw.

TData

TData = TQueryFnData

The type data ends up as after select runs. Defaults to TQueryFnData here, though injectInfiniteQuery itself defaults it to InfiniteData<TQueryFnData> — the shape data actually has when no select is used.

TQueryKey

TQueryKey extends QueryKey = QueryKey

The type of your queryKey.

TPageParam

TPageParam = unknown

The type of the parameter passed to queryFn to fetch a given page.