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
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion docs/framework/angular/reference/interfaces/CancelOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ id: CancelOptions
title: CancelOptions
---

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

Options for cancelling an in-flight fetch, e.g. via `query.cancel()`.
They are carried on the [CancelledError](../classes/CancelledError.md) that the cancelled fetch rejects with.

## Properties

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:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575)
Defined in: [packages/query-core/src/types.ts:1623](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1623)

## 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:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634)
Defined in: [packages/query-core/src/types.ts:669](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L669)

## 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:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758)
Defined in: [packages/query-core/src/types.ts:793](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L793)

## 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:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770)
Defined in: [packages/query-core/src/types.ts:805](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L805)

## 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:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615)
Defined in: [packages/query-core/src/types.ts:650](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L650)

## Deprecated

Expand Down
5 changes: 4 additions & 1 deletion docs/framework/angular/reference/interfaces/InfiniteData.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ id: InfiniteData
title: InfiniteData
---

Defined in: [packages/query-core/src/types.ts:220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L220)
Defined in: [packages/query-core/src/types.ts:251](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L251)

The data shape of an infinite query: every page fetched so far, plus the page param each one was fetched with.
`pages` and `pageParams` are index-aligned β€” `pageParams[i]` is the param that produced `pages[i]`.

## Type Parameters

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:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024)
Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059)

## 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:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101)
Defined in: [packages/query-core/src/types.ts:1136](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1136)

## 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:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083)
Defined in: [packages/query-core/src/types.ts:1118](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1118)

## 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:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559)
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: InfiniteQueryObserverPendingResult
title: InfiniteQueryObserverPendingResult
---

Defined in: [packages/query-core/src/types.ts:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066)
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: InfiniteQueryObserverPlaceholderResult
title: InfiniteQueryObserverPlaceholderResult
---

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

## 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:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119)
Defined in: [packages/query-core/src/types.ts:1154](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1154)

## 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:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135)
Defined in: [packages/query-core/src/types.ts:1170](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1170)

## 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:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371)
Defined in: [packages/query-core/src/types.ts:406](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L406)

## Extends

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

Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L360)
Defined in: [packages/query-core/src/types.ts:395](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L395)

## Extended by

Expand Down
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:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755)
Defined in: [packages/query-core/src/types.ts:790](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L790)

## 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:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735)
Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770)

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:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352)
Defined in: [packages/query-core/src/types.ts:1400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1400)

## 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:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403)
Defined in: [packages/query-core/src/types.ts:1451](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1451)

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:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510)
Defined in: [packages/query-core/src/types.ts:1558](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1558)

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:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468)
Defined in: [packages/query-core/src/types.ts:1516](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1516)

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:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489)
Defined in: [packages/query-core/src/types.ts:1537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1537)

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:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335)
Defined in: [packages/query-core/src/types.ts:1383](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1383)

## 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:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531)
Defined in: [packages/query-core/src/types.ts:1579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1579)

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:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225)
Defined in: [packages/query-core/src/types.ts:1273](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1273)

## 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:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608)
Defined in: [packages/query-core/src/types.ts:1665](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1665)

## 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:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563)
Defined in: [packages/query-core/src/types.ts:1611](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1611)

## 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:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594)
Defined in: [packages/query-core/src/types.ts:629](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L629)

## 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:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787)
Defined in: [packages/query-core/src/types.ts:822](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L822)

## 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:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946)
Defined in: [packages/query-core/src/types.ts:981](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L981)

## 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:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930)
Defined in: [packages/query-core/src/types.ts:965](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L965)

## 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:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400)
Defined in: [packages/query-core/src/types.ts:435](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L435)

## Extends

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

Defined in: [packages/query-core/src/types.ts:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915)
Defined in: [packages/query-core/src/types.ts:950](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L950)

## Extends

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

Defined in: [packages/query-core/src/types.ts:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994)
Defined in: [packages/query-core/src/types.ts:1029](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1029)

## Extends

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

Defined in: [packages/query-core/src/types.ts:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962)
Defined in: [packages/query-core/src/types.ts:997](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L997)

## Extends

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

Defined in: [packages/query-core/src/types.ts:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978)
Defined in: [packages/query-core/src/types.ts:1013](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1013)

## Extends

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

Defined in: [packages/query-core/src/types.ts:243](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L243)
Defined in: [packages/query-core/src/types.ts:278](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L278)

## Type Parameters

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

Defined in: [packages/query-core/src/types.ts:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724)
Defined in: [packages/query-core/src/types.ts:759](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L759)

## Extends

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

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:786](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L786)

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
Loading
Loading