Class InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

Type Parameters

TQueryFnData = unknown
TError = DefaultError
TData = InfiniteData<TQueryFnData>
TQueryData = TQueryFnData
TQueryKey extends QueryKey = QueryKey
TPageParam = unknown

Hierarchy (view full)

QueryObserver<TQueryFnData, TError, TData, InfiniteData<TQueryData, TPageParam>, TQueryKey>
- InfiniteQueryObserver

Constructors

constructor

new InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>(client, options): InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>
Type Parameters
- TQueryFnData = unknown
- TError = Error
- TData = InfiniteData<TQueryFnData, unknown>
- TQueryData = TQueryFnData
- TQueryKey extends QueryKey = QueryKey
- TPageParam = unknown
Parameters
- client: QueryClient
- options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>
Returns InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>
Overrides QueryObserver.constructor
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/infiniteQueryObserver.d.ts:10

Properties

`Private` #private

#private: any

`Protected` listeners

listeners: Set<QueryObserverListener<TData, TError>>

options

options: QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryData, TPageParam>, TQueryKey, never>

subscribe: ((listener?) => (() => void))

Type declaration

- (listener?): (() => void)
- Parameters
  - Optional listener: InfiniteQueryObserverListener<TData, TError>
  Returns (() => void)
  - - (): void
    - Returns void

Methods

`Protected` bindMethods

bindMethods(): void
Returns void
Overrides QueryObserver.bindMethods
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/infiniteQueryObserver.d.ts:11

`Protected` createResult

createResult(query, options): InfiniteQueryObserverResult<TData, TError>
Parameters
- query: Query<TQueryFnData, TError, InfiniteData<TQueryData, TPageParam>, TQueryKey>
- options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>
Returns InfiniteQueryObserverResult<TData, TError>
Overrides QueryObserver.createResult
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/infiniteQueryObserver.d.ts:16

destroy

destroy(): void
Returns void
Inherited from QueryObserver.destroy
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:732

fetchNextPage

fetchNextPage(options?): Promise<InfiniteQueryObserverResult<TData, TError>>
Parameters
- Optional options: FetchNextPageOptions
Returns Promise<InfiniteQueryObserverResult<TData, TError>>
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/infiniteQueryObserver.d.ts:14

fetchOptimistic

fetchOptimistic(options): Promise<QueryObserverResult<TData, TError>>
Parameters
- options: QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryData, TPageParam>, TQueryKey, never>
Returns Promise<QueryObserverResult<TData, TError>>
Inherited from QueryObserver.fetchOptimistic
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:739

fetchPreviousPage

fetchPreviousPage(options?): Promise<InfiniteQueryObserverResult<TData, TError>>
Parameters
- Optional options: FetchPreviousPageOptions
Returns Promise<InfiniteQueryObserverResult<TData, TError>>
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/infiniteQueryObserver.d.ts:15

getCurrentQuery

getCurrentQuery(): Query<TQueryFnData, TError, InfiniteData<TQueryData, TPageParam>, TQueryKey>
Returns Query<TQueryFnData, TError, InfiniteData<TQueryData, TPageParam>, TQueryKey>
Inherited from QueryObserver.getCurrentQuery
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:737

getOptimisticResult

getOptimisticResult(options): InfiniteQueryObserverResult<TData, TError>
Parameters
- options: DefaultedInfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>
Returns InfiniteQueryObserverResult<TData, TError>
Overrides QueryObserver.getOptimisticResult
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/infiniteQueryObserver.d.ts:13

hasListeners

hasListeners(): boolean
Returns boolean
Inherited from QueryObserver.hasListeners
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/subscribable.d.ts:6

onQueryUpdate

onQueryUpdate(): void
Returns void
Inherited from QueryObserver.onQueryUpdate
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:743

`Protected` onSubscribe

onSubscribe(): void
Returns void
Inherited from QueryObserver.onSubscribe
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:728

`Protected` onUnsubscribe

onUnsubscribe(): void
Returns void
Inherited from QueryObserver.onUnsubscribe
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:729

refetch

refetch(__namedParameters?): Promise<QueryObserverResult<TData, TError>>
Parameters
- Optional __namedParameters: RefetchOptions
Returns Promise<QueryObserverResult<TData, TError>>
Inherited from QueryObserver.refetch
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:738

setOptions

setOptions(options?, notifyOptions?): void
Parameters
- Optional options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>
- Optional notifyOptions: NotifyOptions
Returns void
Overrides QueryObserver.setOptions
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/infiniteQueryObserver.d.ts:12

shouldFetchOnReconnect

shouldFetchOnReconnect(): boolean
Returns boolean
Inherited from QueryObserver.shouldFetchOnReconnect
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:730

shouldFetchOnWindowFocus

shouldFetchOnWindowFocus(): boolean
Returns boolean
Inherited from QueryObserver.shouldFetchOnWindowFocus
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:731

trackResult

trackResult(result): QueryObserverResult<TData, TError>
Parameters
- result: QueryObserverResult<TData, TError>
Returns QueryObserverResult<TData, TError>
Inherited from QueryObserver.trackResult
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:736

updateResult

updateResult(notifyOptions?): void
Parameters
- Optional notifyOptions: NotifyOptions
Returns void
Inherited from QueryObserver.updateResult
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:742

Class InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

Type Parameters

TQueryFnData = unknown

TError = DefaultError

TData = InfiniteData<TQueryFnData>

TQueryData = TQueryFnData

TQueryKey extends QueryKey = QueryKey

TPageParam = unknown

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TQueryFnData = unknown

TError = Error

TData = InfiniteData<TQueryFnData, unknown>

TQueryData = TQueryFnData

TQueryKey extends QueryKey = QueryKey

TPageParam = unknown

Parameters

client: QueryClient

options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

Returns InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

Properties

Private #private

Protected fetch

Type declaration

Parameters

fetchOptions: ObserverFetchOptions

Returns Promise<InfiniteQueryObserverResult<TData, TError>>

getCurrentResult

Type declaration

Returns InfiniteQueryObserverResult<TData, TError>

Protected listeners

options

subscribe

Type declaration

Parameters

Optional listener: InfiniteQueryObserverListener<TData, TError>

Returns (() => void)

Returns void

Methods

Protected bindMethods

Returns void

Protected createResult

Parameters

query: Query<TQueryFnData, TError, InfiniteData<TQueryData, TPageParam>, TQueryKey>

options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

Returns InfiniteQueryObserverResult<TData, TError>

destroy

Returns void

fetchNextPage

Parameters

Optional options: FetchNextPageOptions

Returns Promise<InfiniteQueryObserverResult<TData, TError>>

fetchOptimistic

Parameters

options: QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryData, TPageParam>, TQueryKey, never>

Returns Promise<QueryObserverResult<TData, TError>>

fetchPreviousPage

Parameters

Optional options: FetchPreviousPageOptions

Returns Promise<InfiniteQueryObserverResult<TData, TError>>

getCurrentQuery

Returns Query<TQueryFnData, TError, InfiniteData<TQueryData, TPageParam>, TQueryKey>

getOptimisticResult

Parameters

options: DefaultedInfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

Returns InfiniteQueryObserverResult<TData, TError>

hasListeners

Returns boolean

onQueryUpdate

Returns void

Protected onSubscribe

Returns void

Protected onUnsubscribe

Returns void

`Private` #private

`Protected` fetch

`Protected` listeners

`Optional` listener: InfiniteQueryObserverListener<TData, TError>

`Protected` bindMethods

`Protected` createResult

`Optional` options: FetchNextPageOptions

`Optional` options: FetchPreviousPageOptions

`Protected` onSubscribe

`Protected` onUnsubscribe

`Optional` __namedParameters: RefetchOptions

`Optional` options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

`Optional` notifyOptions: NotifyOptions

`Optional` notifyOptions: NotifyOptions