setQueryData(...)

The method enables direct access to the QueryClient cache to set the data for a specific Query. See the TanStack queryClient.setQueryData 🌴 documentation.

Without options

const data = qraft.<service>.<operation>.setQueryData(
  parameters,
  data,
  queryClient
);

Arguments

1. parameters: { path, query, header } | QueryKey
   • Required parameters to set the data in the Query Cache.
   • Instead of an object with {path, query, header}, you can pass a QueryKey as an array which is also strictly-typed ✨
2. data: TData
   • Required data to set in the cache
3. queryClient: QueryClient
   • Required QueryClient instance to use

With options

const data = qraft.<service>.<operation>.setQueryData(
  parameters,
  data,
  options,
  queryClient
);

Arguments

1. parameters: { path, query, header } | QueryKey
   • Required parameters to set the data in the Query Cache.
   • Instead of an object with {path, query, header}, you can pass a QueryKey as an array which is also strictly-typed ✨
2. data: TData
   • Required data to set in the cache
3. options: SetQueryDataOptions
   • Optional options to set the data in the cache
   • See the TanStack queryClient.setQueryData 🌴 documentation.
4. queryClient: QueryClient
   • Required QueryClient instance to use

Returns

The data from the updater or undefined if it returns nothing, strictly-typed ✨

Example

Without options

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

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

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

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

With options

const pet = qraft.pet.getPetById.setQueryData(
  { path: { petId: 123 } },
  { 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 pet = qraft.pet.getPetById.setQueryData(
  [
    { method: 'get', url: '/pet/{petId}' },
    { petId: 123 },
  ],
  { id: 123, name: 'Rex' },
  queryClient
);