Function removeMatchingQueries

Remove queries in the cache that match any of the specified key groups.

This function uses the predicate option to filter queries whose keys match any of the key groups provided. A query's key is considered a match if it contains all the keys from at least one of the key groups. The function then remove all such matching queries using queryClient.removeQueries.

Example

import { removeMatchingQueries } from 'react-query-manager';

// Define key groups where each group is an array of keys that must all be present in the queryKey to be considered a match.
const keyGroups = [
  ['path', 'get-list'],    // Key group 1
  ['path', 'get-one'],  // Key group 2
];

// Remove queries with keys matching any of the key groups
removeMatchingQueries({ queryKeys: keyGroups });
  • removeMatchingQueries(params): void

  • Parameters

    • params: {
          queryKeys: any[][];
      }
      • queryKeys: any[][]

        An array of arrays, where each inner array represents a group of keys that must all be present in a query's key for that query to be removed. Example: [['path', 'get-list'], ['path', 'get-one']].

        This function:

        • Retrieves all cached queries.
        • Checks if the key of each query matches any of the provided key groups.
        • Remove the queries whose keys match any of the specified key groups.

    Returns void

    • This function does not return a value.

Settings

Member Visibility