Some methods within React Query accept a QueryFilters or MutationFilters object.
A query filter is an object with certain conditions to match a query with:
// Cancel all queries
await queryClient.cancelQueries()
// Remove all inactive queries that begin with `posts` in the key
queryClient.removeQueries('posts', { inactive: true })
// Refetch all active queries
await queryClient.refetchQueries({ active: true })
// Refetch all active queries that begin with `posts` in the key
await queryClient.refetchQueries('posts', { active: true })
// Cancel all queries
await queryClient.cancelQueries()
// Remove all inactive queries that begin with `posts` in the key
queryClient.removeQueries('posts', { inactive: true })
// Refetch all active queries
await queryClient.refetchQueries({ active: true })
// Refetch all active queries that begin with `posts` in the key
await queryClient.refetchQueries('posts', { active: true })
A query filter object supports the following properties:
A mutation filter is an object with certain conditions to match a mutation with:
// Get the number of all fetching mutations
await queryClient.isMutating()
// Filter mutations by mutationKey
await queryClient.isMutating({ mutationKey: "post" })
// Filter mutations using a predicate function
await queryClient.isMutating({ predicate: (mutation) => mutation.options.variables?.id === 1 })
// Get the number of all fetching mutations
await queryClient.isMutating()
// Filter mutations by mutationKey
await queryClient.isMutating({ mutationKey: "post" })
// Filter mutations using a predicate function
await queryClient.isMutating({ predicate: (mutation) => mutation.options.variables?.id === 1 })
A mutation filter object supports the following properties:
“This course is the best way to learn how to use React Query in real-world applications.”—Tanner LinsleyGet the course