Skip to content

Commit

Permalink
docs: revert docs for QueryCache (#5221)
Browse files Browse the repository at this point in the history
  • Loading branch information
judicaelandria authored Apr 2, 2023
1 parent 88f144c commit 1c5165e
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions docs/react/reference/QueryCache.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ The `QueryCache` is the storage mechanism for TanStack Query. It stores all the
import { QueryCache } from '@tanstack/react-query'

const queryCache = new QueryCache({
onError: error => {
onError: (error) => {
console.log(error)
},
onSuccess: data => {
onSuccess: (data) => {
console.log(data)
},
onSettled: (data, error) => {
console.log(data, error)
},
})

const query = queryCache.find({ queryKey: ['posts'] })
const query = queryCache.find(['posts'])
```

Its available methods are:
Expand All @@ -47,6 +47,7 @@ Its available methods are:
## Global callbacks

The `onError`, `onSuccess` and `onSettled` callbacks on the QueryCache can be used to handle these events on a global level. They are different to `defaultOptions` provided to the QueryClient because:

- `defaultOptions` can be overridden by each Query - the global callbacks will **always** be called.
- `defaultOptions` callbacks will be called once for each Observer, while the global callbacks will only be called once per Query.

Expand All @@ -57,11 +58,12 @@ The `onError`, `onSuccess` and `onSettled` callbacks on the QueryCache can be us
> Note: This is not typically needed for most applications, but can come in handy when needing more information about a query in rare scenarios (eg. Looking at the query.state.dataUpdatedAt timestamp to decide whether a query is fresh enough to be used as an initial value)
```tsx
const query = queryCache.find({ queryKey })
const query = queryCache.find(queryKey)
```

**Options**

- `queryKey?: QueryKey`: [Query Keys](../guides/query-keys)
- `filters?: QueryFilters`: [Query Filters](../guides/filters#query-filters)

**Returns**
Expand All @@ -76,11 +78,12 @@ const query = queryCache.find({ queryKey })
> Note: This is not typically needed for most applications, but can come in handy when needing more information about a query in rare scenarios
```tsx
const queries = queryCache.findAll({ queryKey })
const queries = queryCache.findAll(queryKey)
```

**Options**

- `queryKey?: QueryKey`: [Query Keys](../guides/query-keys)
- `filters?: QueryFilters`: [Query Filters](../guides/filters#query-filters)

**Returns**
Expand All @@ -93,7 +96,7 @@ const queries = queryCache.findAll({ queryKey })
The `subscribe` method can be used to subscribe to the query cache as a whole and be informed of safe/known updates to the cache like query states changing or queries being updated, added or removed

```tsx
const callback = event => {
const callback = (event) => {
console.log(event.type, event.query)
}

Expand All @@ -117,6 +120,7 @@ The `clear` method can be used to clear the cache entirely and start fresh.
```tsx
queryCache.clear()
```

[//]: # 'Materials'

## Further reading
Expand Down

0 comments on commit 1c5165e

Please sign in to comment.