setQueriesData(...)

The synchronous function that can be used to immediately update cached data of multiple queries by using filter. Only queries that match the passed QueryKey will be updated. No new cache entries will be created. See the TanStack queryClient.setQueriesData 🌴 documentation.

Without options

const data = qraft.<service>.<operation>.setQueriesData(
  filters,
  updater,
  queryClient
);

Arguments

1. filters: QueryFiltersByParameters | QueryFiltersByQueryKey
   • Required, represents the Query Filters 🌴 to be used, strictly-typed ✨
   • filters.parameters: { path, query, header } will be used for filtering queries by parameters
   • filters.infinite: boolean will be used to filter infinite or normal queries
   • filters.queryKey: QueryKey will be used for filtering queries by QueryKey instead of parameters
     • filters.queryKey and filters.parameters are mutually exclusive
   • filters.predicate?: (query: Query) => boolean will be used for filtering queries by custom predicate
2. updater: TData | (oldData: TData | undefined) => TData | undefined
   • Required updater to be used to set the data in the Query Cache
3. queryClient: QueryClient
   • Required QueryClient instance to use

With options

const data = qraft.<service>.<operation>.setQueriesData(
  filters,
  updater,
  options,
  queryClient
);

Arguments

1. filters: QueryFiltersByParameters | QueryFiltersByQueryKey
   • Required, represents the Query Filters 🌴 to be used, strictly-typed ✨
   • filters.parameters: { path, query, header } will be used for filtering queries by parameters
   • filters.infinite: boolean will be used to filter infinite or normal queries
   • filters.queryKey: QueryKey will be used for filtering queries by QueryKey instead of parameters
     • filters.queryKey and filters.parameters are mutually exclusive
   • filters.predicate?: (query: Query) => boolean will be used for filtering queries by custom predicate
2. updater: TData | (oldData: TData | undefined) => TData | undefined
   • Required updater to be used to set the data in the Query Cache
3. options: SetQueryDataOptions
   • Required options to set the data in the cache
   • See the TanStack queryClient.setQueriesData 🌴 documentation.
4. queryClient: QueryClient
   • Required QueryClient instance to use

Returns

Array<TData | undefined> - The data that was set in the cache.

Example

Without options

const parameters = { path: { petId: 123 } };

qraft.pet.getPetById.setQueriesData(
  { parameters, infinite: false },
  { id: 123, name: 'Rex' },
  queryClient
);

const pet = qraft.pet.getPetById.getQueryData(
  parameters,
  queryClient
);

expect(pet).toEqual({
  id: 123,
  name: 'Rex',
});

With options

const pets = qraft.pet.getPetById.setQueriesData(
  { parameters: { path: { petId: 123 } }, infinite: false },
  { id: 123, name: 'Rex' },
  { updatedAt: Date.now() - 60_000 },
  queryClient
);

With QueryKey

It's also possible to use a QueryKey as an array instead of an object with {path, query, header}:

const pets = qraft.pet.getPetById.setQueriesData(
  {
    queryKey: [
      { method: 'get', url: '/pet/{petId}', infinite: false },
      { petId: 123 },
    ],
  },
  { id: 123, name: 'Rex' },
  queryClient
);