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.

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

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

Merged
Changes from 1 commit
Commits
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/guides/filters.md
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 a final filter on all matched queries. If no other criteria are specified, this function will be evaluated on every query in the cache.
benlongo marked this conversation as resolved.
Show resolved Hide resolved

## `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 a final filter on all matched queries. If no other criteria are specified, this function will be evaluated on every mutation in the cache.
benlongo marked this conversation as resolved.
Show resolved Hide resolved