Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarify interaction of query filter predicates with other criteria #4532

Merged
merged 4 commits into from Jan 13, 2023
Merged

docs: clarify interaction of query filter predicates with other criteria #4532

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6984cf9
docs: clarify interaction of query filter predicates with other criteria
benlongo Nov 21, 2022
51736ef
Update docs/guides/filters.md
benlongo Nov 27, 2022
6a31666
Update docs/guides/filters.md
benlongo Nov 27, 2022
6ff4566
Merge branch 'main' into pr/4532
TkDodo Jan 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/react/guides/filters.md
View file
Open in desktop
Expand Up @@ -41,7 +41,7 @@ A query filter object supports the following properties:
- When set to `paused` it will match queries that wanted to fetch, but have been `paused`.
- When set to `idle` it will match queries that are not fetching.
- `predicate?: (query: Query) => boolean`
- This predicate function will be called for every single query in the cache and be expected to return truthy for queries that are `found`.
- This predicate function will be used as a final filter on all matching queries. If no other filters are specified, this function will be evaluated against every query in the cache.

## `Mutation Filters`

Expand All @@ -62,12 +62,12 @@ await queryClient.isMutating({

A mutation filter object supports the following properties:

- `mutationKey?: MutationKey`
- Set this property to define a mutation key to match on.
- `exact?: boolean`
- If you don't want to search mutations inclusively by mutation key, you can pass the `exact: true` option to return only the mutation with the exact mutation key you have passed.
- `fetching?: boolean`
- When set to `true` it will match mutations that are currently fetching.
- When set to `false` it will match mutations that are not fetching.
- `predicate?: (mutation: Mutation) => boolean`
- This predicate function will be called for every single mutation in the cache and be expected to return truthy for mutations that are `found`.
- `mutationKey?: MutationKey`
- Set this property to define a mutation key to match on.
- This predicate function will be used as a final filter on all matching mutations. If no other filters are specified, this function will be evaluated against every mutation in the cache.