docs(query-core): add matchQuery and matchMutation utils (#7643)

* docs(query-core): add matchQuery and matchMutation mentions in filters documentation * docs(query-core): clarifies filters type * Format --------- Co-authored-by: Dominik Dorfmeister <[email protected]> Co-authored-by: Lachlan Collins <[email protected]>
TanStack · Jul 18, 2024 · 81ca333 · 81ca333
1 parent d8ab552
commit 81ca333
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/framework/react/guides/filters.md b/docs/framework/react/guides/filters.md
@@ -70,3 +70,21 @@ A mutation filter object supports the following properties:
   - Allows for filtering mutations according to their status.
 - `predicate?: (mutation: Mutation) => boolean`
   - 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.
+
+## Utils
+
+### `matchQuery`
+
+```tsx
+const isMatching = matchQuery(filters, query)
+```
+
+Returns a boolean that indicates whether a query matches the provided set of query filters.
+
+### `matchMutation`
+
+```tsx
+const isMatching = matchMutation(filters, mutation)
+```
+
+Returns a boolean that indicates whether a mutation matches the provided set of mutation filters.