Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: CancelOptions
title: CancelOptions
---

Defined in: [packages/query-core/src/types.ts:1582](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1582)
Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The type of the parameter passed to `queryFn` to fetch a given page.
| <a id="getpreviouspageparam"></a> `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. |
| <a id="initialdata"></a> `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. |
| <a id="initialdataupdatedat"></a> `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. |
| <a id="initialpageparam"></a> `initialPageParam` | `TPageParam` | `undefined` | - |
| <a id="initialpageparam"></a> `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. |
| <a id="maxpages"></a> `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. |
| <a id="meta"></a> `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. |
| <a id="networkmode"></a> `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: DefaultOptions
title: DefaultOptions
---

Defined in: [packages/query-core/src/types.ts:1568](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1568)
Defined in: [packages/query-core/src/types.ts:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575)

## Type Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: EnsureQueryDataOptions
title: EnsureQueryDataOptions
---

Defined in: [packages/query-core/src/types.ts:627](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L627)
Defined in: [packages/query-core/src/types.ts:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634)

## Deprecated

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: FetchNextPageOptions
title: FetchNextPageOptions
---

Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751)
Defined in: [packages/query-core/src/types.ts:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: FetchPreviousPageOptions
title: FetchPreviousPageOptions
---

Defined in: [packages/query-core/src/types.ts:763](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L763)
Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: FetchQueryOptions
title: FetchQueryOptions
---

Defined in: [packages/query-core/src/types.ts:608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L608)
Defined in: [packages/query-core/src/types.ts:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615)

## Deprecated

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InfiniteQueryObserverBaseResult
title: InfiniteQueryObserverBaseResult
---

Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017)
Defined in: [packages/query-core/src/types.ts:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingErrorResult
title: InfiniteQueryObserverLoadingErrorResult
---

Defined in: [packages/query-core/src/types.ts:1094](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1094)
Defined in: [packages/query-core/src/types.ts:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingResult
title: InfiniteQueryObserverLoadingResult
---

Defined in: [packages/query-core/src/types.ts:1076](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1076)
Defined in: [packages/query-core/src/types.ts:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InfiniteQueryObserverOptions
title: InfiniteQueryObserverOptions
---

Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L552)
Defined in: [packages/query-core/src/types.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559)

## Extends

Expand Down Expand Up @@ -41,7 +41,7 @@ Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/q
| <a id="getpreviouspageparam"></a> `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. |
| <a id="initialdata"></a> `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. |
| <a id="initialdataupdatedat"></a> `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. |
| <a id="initialpageparam"></a> `initialPageParam` | `TPageParam` | `undefined` | - |
| <a id="initialpageparam"></a> `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. |
| <a id="maxpages"></a> `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. |
| <a id="meta"></a> `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. |
| <a id="networkmode"></a> `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPendingResult
title: InfiniteQueryObserverPendingResult
---

Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059)
Defined in: [packages/query-core/src/types.ts:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPlaceholderResult
title: InfiniteQueryObserverPlaceholderResult
---

Defined in: [packages/query-core/src/types.ts:1146](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1146)
Defined in: [packages/query-core/src/types.ts:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InfiniteQueryObserverRefetchErrorResult
title: InfiniteQueryObserverRefetchErrorResult
---

Defined in: [packages/query-core/src/types.ts:1112](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1112)
Defined in: [packages/query-core/src/types.ts:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InfiniteQueryObserverSuccessResult
title: InfiniteQueryObserverSuccessResult
---

Defined in: [packages/query-core/src/types.ts:1128](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1128)
Defined in: [packages/query-core/src/types.ts:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InfiniteQueryPageParamsOptions
title: InfiniteQueryPageParamsOptions
---

Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L364)
Defined in: [packages/query-core/src/types.ts:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371)

## Extends

Expand All @@ -29,4 +29,4 @@ Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/q
| ------ | ------ | ------ |
| <a id="getnextpageparam"></a> `getNextPageParam` | (`lastPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `lastPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of `hasNextPage`. |
| <a id="getpreviouspageparam"></a> `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. |
| <a id="initialpageparam"></a> `initialPageParam` | `TPageParam` | - |
| <a id="initialpageparam"></a> `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. |
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/q

## Properties

| Property | Type |
| ------ | ------ |
| <a id="initialpageparam"></a> `initialPageParam` | `TPageParam` |
| Property | Type | Description |
| ------ | ------ | ------ |
| <a id="initialpageparam"></a> `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. |
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InvalidateOptions
title: InvalidateOptions
---

Defined in: [packages/query-core/src/types.ts:748](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L748)
Defined in: [packages/query-core/src/types.ts:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: InvalidateQueryFilters
title: InvalidateQueryFilters
---

Defined in: [packages/query-core/src/types.ts:728](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L728)
Defined in: [packages/query-core/src/types.ts:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735)

Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`.
All provided filters must match; filters that are left unspecified are ignored.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: MutateOptions
title: MutateOptions
---

Defined in: [packages/query-core/src/types.ts:1345](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1345)
Defined in: [packages/query-core/src/types.ts:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352)

## Type Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: MutationObserverBaseResult
title: MutationObserverBaseResult
---

Defined in: [packages/query-core/src/types.ts:1396](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1396)
Defined in: [packages/query-core/src/types.ts:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403)

The raw state stored on a `Mutation` instance. This is the underlying state
that observer results (e.g. `MutationObserverResult`) are derived from.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: MutationObserverErrorResult
title: MutationObserverErrorResult
---

Defined in: [packages/query-core/src/types.ts:1503](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1503)
Defined in: [packages/query-core/src/types.ts:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510)

The raw state stored on a `Mutation` instance. This is the underlying state
that observer results (e.g. `MutationObserverResult`) are derived from.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: MutationObserverIdleResult
title: MutationObserverIdleResult
---

Defined in: [packages/query-core/src/types.ts:1461](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1461)
Defined in: [packages/query-core/src/types.ts:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468)

The raw state stored on a `Mutation` instance. This is the underlying state
that observer results (e.g. `MutationObserverResult`) are derived from.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: MutationObserverLoadingResult
title: MutationObserverLoadingResult
---

Defined in: [packages/query-core/src/types.ts:1482](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1482)
Defined in: [packages/query-core/src/types.ts:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489)

The raw state stored on a `Mutation` instance. This is the underlying state
that observer results (e.g. `MutationObserverResult`) are derived from.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: MutationObserverOptions
title: MutationObserverOptions
---

Defined in: [packages/query-core/src/types.ts:1328](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1328)
Defined in: [packages/query-core/src/types.ts:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: MutationObserverSuccessResult
title: MutationObserverSuccessResult
---

Defined in: [packages/query-core/src/types.ts:1524](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1524)
Defined in: [packages/query-core/src/types.ts:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531)

The raw state stored on a `Mutation` instance. This is the underlying state
that observer results (e.g. `MutationObserverResult`) are derived from.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: MutationOptions
title: MutationOptions
---

Defined in: [packages/query-core/src/types.ts:1218](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1218)
Defined in: [packages/query-core/src/types.ts:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225)

## Extended by

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/interfaces/NotifyEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: NotifyEvent
title: NotifyEvent
---

Defined in: [packages/query-core/src/types.ts:1601](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1601)
Defined in: [packages/query-core/src/types.ts:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: QueryClientConfig
title: QueryClientConfig
---

Defined in: [packages/query-core/src/types.ts:1556](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1556)
Defined in: [packages/query-core/src/types.ts:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563)

## Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: QueryExecuteOptions
title: QueryExecuteOptions
---

Defined in: [packages/query-core/src/types.ts:587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L587)
Defined in: [packages/query-core/src/types.ts:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: QueryObserverBaseResult
title: QueryObserverBaseResult
---

Defined in: [packages/query-core/src/types.ts:780](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L780)
Defined in: [packages/query-core/src/types.ts:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787)

## Extended by

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: QueryObserverLoadingErrorResult
title: QueryObserverLoadingErrorResult
---

Defined in: [packages/query-core/src/types.ts:939](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L939)
Defined in: [packages/query-core/src/types.ts:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: QueryObserverLoadingResult
title: QueryObserverLoadingResult
---

Defined in: [packages/query-core/src/types.ts:923](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L923)
Defined in: [packages/query-core/src/types.ts:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930)

## Extends

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: QueryObserverOptions
title: QueryObserverOptions
---

Defined in: [packages/query-core/src/types.ts:393](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L393)
Defined in: [packages/query-core/src/types.ts:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400)

## Extends

Expand Down
Loading
Loading