QueryClient

Provides cache reads, fetches, invalidation, removal, and subscriptions for queries.

Signature

interface QueryClient

Members

function cancelQueries(options?: InvalidateQueriesOptions): void

function entries(): QueryEntry<unknown>[]

function fetchQuery&lt;TData&gt;(options: FetchQueryOptions&lt;TData&gt;): Promise&lt;TData&gt;
function fetchQuery&lt;TDefinition&gt;(definition: TDefinition, options?: QueryDefinitionFetchOptions&lt;QueryDefinitionData&lt;TDefinition&gt;&gt;): Promise&lt;QueryDefinitionData&lt;TDefinition&gt;&gt;

function getQueryData&lt;TData&gt;(queryKey: QueryKey): TData | undefined
function getQueryData&lt;TDefinition&gt;(definition: TDefinition): QueryDefinitionData&lt;TDefinition&gt; | undefined

function getQueryEntry&lt;TData&gt;(queryKey: QueryKey): QueryEntry&lt;TData&gt; | undefined
function getQueryEntry&lt;TDefinition&gt;(definition: TDefinition): QueryEntry&lt;QueryDefinitionData&lt;TDefinition&gt;&gt; | undefined

function invalidateQueries(options?: InvalidateQueriesOptions): void

function prefetchQuery&lt;TData&gt;(options: FetchQueryOptions&lt;TData&gt;): Promise&lt;void&gt;
function prefetchQuery&lt;TDefinition&gt;(definition: TDefinition, options?: QueryDefinitionFetchOptions&lt;QueryDefinitionData&lt;TDefinition&gt;&gt;): Promise&lt;void&gt;

function removeQueries(options?: InvalidateQueriesOptions): void

function setQueryData&lt;TData&gt;(queryKey: QueryKey, data: TData | (previous: TData | undefined): TData): number
function setQueryData&lt;TDefinition&gt;(definition: TDefinition, data: QueryDefinitionData&lt;TDefinition&gt; | (previous: QueryDefinitionData&lt;TDefinition&gt; | undefined): QueryDefinitionData&lt;TDefinition&gt;): number

function subscribe&lt;TData&gt;(queryKey: QueryKey, listener: (entry: QueryEntry&lt;TData&gt;): void, options?: QuerySubscriptionOptions): (): void