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
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions docs/framework/angular/reference/classes/CancelledError.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: CancelledError
title: CancelledError
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

Defined in: [packages/query-core/src/retryer.ts:120](https://github.com/TanStack/query/blob/main/packages/query-core/src/retryer.ts#L120)

The error thrown by a `Retryer` (and surfaced to `query.promise`/`mutation`) when a fetch is cancelled, e.g. via
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: InfiniteQueryObserver
title: InfiniteQueryObserver
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

Defined in: [packages/query-core/src/infiniteQueryObserver.ts:40](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L40)

An `InfiniteQueryObserver` extends `QueryObserver` to observe and switch
Expand Down Expand Up @@ -55,7 +57,7 @@ const unsubscribe = observer.subscribe((result) => console.log(result))
### Constructor

```ts
new InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryKey, TPageParam>(client: QueryClient, options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryKey, TPageParam>;
new InfiniteQueryObserver<TQueryFnData = unknown, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(client: QueryClient, options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryKey, TPageParam>;
```

Defined in: [packages/query-core/src/infiniteQueryObserver.ts:82](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L82)
Expand Down
4 changes: 3 additions & 1 deletion docs/framework/angular/reference/classes/Mutation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: Mutation
title: Mutation
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

Defined in: [packages/query-core/src/mutation.ts:138](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutation.ts#L138)

Represents a single mutation attempt. A `Mutation` holds the mutation's
Expand Down Expand Up @@ -49,7 +51,7 @@ const mutation = mutationCache.find({ mutationKey: ['addPost'] })
### Constructor

```ts
new Mutation<TData, TError, TVariables, TOnMutateResult>(config: MutationConfig<TData, TError, TVariables, TOnMutateResult>): Mutation<TData, TError, TVariables, TOnMutateResult>;
new Mutation<TData = unknown, TError = Error, TVariables = unknown, TOnMutateResult = unknown>(config: MutationConfig<TData, TError, TVariables, TOnMutateResult>): Mutation<TData, TError, TVariables, TOnMutateResult>;
```
Defined in: [packages/query-core/src/mutation.ts:155](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutation.ts#L155)
Expand Down
4 changes: 3 additions & 1 deletion docs/framework/angular/reference/classes/MutationCache.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: MutationCache
title: MutationCache
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

Defined in: [packages/query-core/src/mutationCache.ts:123](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L123)

The `MutationCache` is the storage for mutations.
Expand Down Expand Up @@ -88,7 +90,7 @@ mutationCache.clear()
### find()

```ts
find<TData, TError, TVariables, TOnMutateResult>(filters: MutationFilters):
find<TData = unknown, TError = Error, TVariables = any, TOnMutateResult = unknown>(filters: MutationFilters):
| Mutation<TData, TError, TVariables, TOnMutateResult>
| undefined;
```
Expand Down
4 changes: 3 additions & 1 deletion docs/framework/angular/reference/classes/MutationObserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: MutationObserver
title: MutationObserver
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

Defined in: [packages/query-core/src/mutationObserver.ts:37](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L37)

Observes a single mutation and derives a `MutationObserverResult` from it.
Expand Down Expand Up @@ -47,7 +49,7 @@ const observer = new MutationObserver(queryClient, {
### Constructor

```ts
new MutationObserver<TData, TError, TVariables, TOnMutateResult>(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>): MutationObserver<TData, TError, TVariables, TOnMutateResult>;
new MutationObserver<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>): MutationObserver<TData, TError, TVariables, TOnMutateResult>;
```
Defined in: [packages/query-core/src/mutationObserver.ts:57](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L57)
Expand Down
11 changes: 7 additions & 4 deletions docs/framework/angular/reference/classes/QueriesObserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: QueriesObserver
title: QueriesObserver
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

Defined in: [packages/query-core/src/queriesObserver.ts:64](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L64)

A `QueriesObserver` watches an array of queries at once, exposing them as
Expand Down Expand Up @@ -39,10 +41,11 @@ const unsubscribe = observer.subscribe((result) => {
### Constructor

```ts
new QueriesObserver<TCombinedResult>(
new QueriesObserver<TCombinedResult = QueryObserverResult[]>(
client: QueryClient,
queries: QueryObserverOptions<any, any, any, any, any, never>[],
options?: QueriesObserverOptions<TCombinedResult>): QueriesObserver<TCombinedResult>;
options?: QueriesObserverOptions<TCombinedResult>
): QueriesObserver<TCombinedResult>;
```

Defined in: [packages/query-core/src/queriesObserver.ts:78](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L78)
Expand Down Expand Up @@ -140,7 +143,7 @@ The managed query observers.
### getOptimisticResult()

```ts
getOptimisticResult(queries: QueryObserverOptions<unknown, Error, unknown, unknown, readonly unknown[], never>[], combine: CombineFn<TCombinedResult> | undefined): [QueryObserverResult[], (r?: QueryObserverResult[]) => TCombinedResult, () => QueryObserverResult[]];
getOptimisticResult(queries: QueryObserverOptions<unknown, Error, unknown, unknown, readonly unknown[], never>[], combine: CombineFn<TCombinedResult> | undefined): [rawResult: QueryObserverResult[], combineResult: (r?: QueryObserverResult[]) => TCombinedResult, trackResult: () => QueryObserverResult[]];
```

Defined in: [packages/query-core/src/queriesObserver.ts:253](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L253)
Expand All @@ -167,7 +170,7 @@ The `combine` function used by the returned `combineResult`, if any.

#### Returns

\[[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[], (`r?`: [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]) => `TCombinedResult`, () => [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]\]
\[`rawResult`: [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[], `combineResult`: (`r?`: [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]) => `TCombinedResult`, `trackResult`: () => [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]\]

A tuple of the per-query results, a function that computes the combined result, and a
function that returns the results wrapped for property-access tracking.
Expand Down
6 changes: 4 additions & 2 deletions docs/framework/angular/reference/classes/Query.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: Query
title: Query
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

Defined in: [packages/query-core/src/query.ts:283](https://github.com/TanStack/query/blob/main/packages/query-core/src/query.ts#L283)

Represents a single cached query. A `Query` holds the query's key, options,
Expand Down Expand Up @@ -51,7 +53,7 @@ if (query) {
### Constructor

```ts
new Query<TQueryFnData, TError, TData, TQueryKey>(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>): Query<TQueryFnData, TError, TData, TQueryKey>;
new Query<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>): Query<TQueryFnData, TError, TData, TQueryKey>;
```
Defined in: [packages/query-core/src/query.ts:304](https://github.com/TanStack/query/blob/main/packages/query-core/src/query.ts#L304)
Expand Down Expand Up @@ -452,7 +454,7 @@ Returns `true` if the query's data is stale relative to the given

##### staleTime?

`number` \| `"static"`
`number` \| `"static"` = `0`

The time, in milliseconds, after which data is considered stale, or
`'static'` to never treat existing data as stale. A query without data is stale either way.
Expand Down
11 changes: 7 additions & 4 deletions docs/framework/angular/reference/classes/QueryCache.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: QueryCache
title: QueryCache
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

Defined in: [packages/query-core/src/queryCache.ts:140](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L140)

The `QueryCache` is the storage mechanism for TanStack Query. It stores all the data, meta
Expand Down Expand Up @@ -67,10 +69,11 @@ Defined in: [packages/query-core/src/queryCache.ts:143](https://github.com/TanSt
### build()

```ts
build<TQueryFnData, TError, TData, TQueryKey>(
build<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(
client: QueryClient,
options: WithRequired<QueryOptions<TQueryFnData, TError, TData, TQueryKey, never>, "queryKey">,
state?: QueryState<TData, TError>): Query<TQueryFnData, TError, TData, TQueryKey>;
state?: QueryState<TData, TError>
): Query<TQueryFnData, TError, TData, TQueryKey>;
```

Defined in: [packages/query-core/src/queryCache.ts:169](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L169)
Expand Down Expand Up @@ -166,7 +169,7 @@ queryCache.clear()
### find()

```ts
find<TQueryFnData, TError, TData>(filters: WithRequired<QueryFilters<readonly unknown[]>, "queryKey">):
find<TQueryFnData = unknown, TError = Error, TData = TQueryFnData>(filters: WithRequired<QueryFilters<readonly unknown[]>, "queryKey">):
| Query<TQueryFnData, TError, TData, readonly unknown[]>
| undefined;
```
Expand Down Expand Up @@ -271,7 +274,7 @@ const queries = queryCache.findAll({ queryKey: ['posts'] })
### get()

```ts
get<TQueryFnData, TError, TData, TQueryKey>(queryHash: string):
get<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(queryHash: string):
| Query<TQueryFnData, TError, TData, TQueryKey>
| undefined;
```
Expand Down
Loading
Loading