Skip to main content
Version: 2.x ๐Ÿšง

getQueryData(...)

The method enables direct access to the QueryClient cache to retrieve the data for a specific Query. See the TanStack queryClient.getQueryData ๐ŸŒด documentation.

const data = api.<service>.<operation>.getQueryData(
parameters
);

Argumentsโ€‹

  1. parameters: { path, query, header } | QueryKey | void
    • Required parameters to retrieve the data from the Query Cache.
    • Instead of an object with { path, query, header }, you can pass a QueryKey as an array which is also strictly-typed โœจ

Returnsโ€‹

The data from the Query Cache for the specific query, strictly-typed โœจ

Exampleโ€‹

const pet = api.pet.getPetById.getQueryData({
path: { petId: 123 },
});

expect(pet?.id).toEqual(123);