snapshot of https://github.com/TanStack/query.git (main, 2026-09-16; blobs > 131072B omitted)
This commit is contained in:
@@ -0,0 +1,93 @@
|
||||
---
|
||||
id: QueryCacheConfig
|
||||
title: QueryCacheConfig
|
||||
---
|
||||
|
||||
Defined in: [packages/query-core/src/queryCache.ts:25](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L25)
|
||||
|
||||
Global callbacks that fire for every query handled by a `QueryCache`, regardless of which
|
||||
component or observer triggered it. Unlike `QueryClient`'s `defaultOptions`, which a query can
|
||||
override, these callbacks are always called. Unlike `MutationCacheConfig`'s callbacks, these
|
||||
are fire-and-forget: their return value is not awaited before the query settles.
|
||||
|
||||
## Properties
|
||||
|
||||
### onError()?
|
||||
|
||||
```ts
|
||||
optional onError: (error, query) => void;
|
||||
```
|
||||
|
||||
Defined in: [packages/query-core/src/queryCache.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L27)
|
||||
|
||||
Called when any query in the cache encounters an error.
|
||||
|
||||
#### Parameters
|
||||
|
||||
##### error
|
||||
|
||||
`Error`
|
||||
|
||||
##### query
|
||||
|
||||
[`Query`](../classes/Query.md)\<`unknown`, `unknown`, `unknown`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
***
|
||||
|
||||
### onSettled()?
|
||||
|
||||
```ts
|
||||
optional onSettled: (data, error, query) => void;
|
||||
```
|
||||
|
||||
Defined in: [packages/query-core/src/queryCache.ts:34](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L34)
|
||||
|
||||
Called when any query in the cache is settled, either successfully or with an error.
|
||||
|
||||
#### Parameters
|
||||
|
||||
##### data
|
||||
|
||||
`unknown`
|
||||
|
||||
##### error
|
||||
|
||||
`Error` | `null`
|
||||
|
||||
##### query
|
||||
|
||||
[`Query`](../classes/Query.md)\<`unknown`, `unknown`, `unknown`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
***
|
||||
|
||||
### onSuccess()?
|
||||
|
||||
```ts
|
||||
optional onSuccess: (data, query) => void;
|
||||
```
|
||||
|
||||
Defined in: [packages/query-core/src/queryCache.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L32)
|
||||
|
||||
Called when any query in the cache is successful.
|
||||
|
||||
#### Parameters
|
||||
|
||||
##### data
|
||||
|
||||
`unknown`
|
||||
|
||||
##### query
|
||||
|
||||
[`Query`](../classes/Query.md)\<`unknown`, `unknown`, `unknown`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
Reference in New Issue
Block a user