API Documentation / @pinia/colada / useQueryCache

Variable: useQueryCache

const useQueryCache: StoreDefinition<"_pc_query", Pick<{
  caches: Ref<EntryMap<UseQueryEntry<unknown, unknown, unknown>>, EntryMap<UseQueryEntry<unknown, unknown, unknown>>>;
  cancel: (entry, reason?) => void;
  cancelQueries: (filters?, reason?) => void;
  create: <TData, TError, TDataInitial>(key, options, initialData?, error, when) => UseQueryEntry<TData, TError, TDataInitial>;
  ensure: <TData, TError, TDataInitial>(opts, previousEntry?) => UseQueryEntry<TData, TError, TDataInitial>;
  ensureDefinedQuery: <T>(fn) => DefineQueryEntry;
  extend: <TData, TError>(_entry) => void;
  fetch: <TData, TError, TDataInitial>(entry, options) => Promise<DataState<TData, TError, TDataInitial>>;
  getEntries: (filters) => UseQueryEntry<unknown, unknown, unknown>[];
  getQueryData: <TData>(key) => undefined | TData;
  invalidate: (entry) => void;
  invalidateQueries: (filters?) => Promise<unknown>;
  refresh: <TData, TError, TDataInitial>(entry, options) => Promise<DataState<TData, TError, TDataInitial>>;
  remove: (entry) => void;
  setEntryState: <TData, TError, TDataInitial>(entry, state) => void;
  setQueriesData: <TData>(filters, updater) => void;
  setQueryData: <TData>(key, data) => void;
  track: (entry, effect) => void;
  untrack: (entry, effect) => void;
}, "caches" | "_s">, Pick<{
  caches: Ref<EntryMap<UseQueryEntry<unknown, unknown, unknown>>, EntryMap<UseQueryEntry<unknown, unknown, unknown>>>;
  cancel: (entry, reason?) => void;
  cancelQueries: (filters?, reason?) => void;
  create: <TData, TError, TDataInitial>(key, options, initialData?, error, when) => UseQueryEntry<TData, TError, TDataInitial>;
  ensure: <TData, TError, TDataInitial>(opts, previousEntry?) => UseQueryEntry<TData, TError, TDataInitial>;
  ensureDefinedQuery: <T>(fn) => DefineQueryEntry;
  extend: <TData, TError>(_entry) => void;
  fetch: <TData, TError, TDataInitial>(entry, options) => Promise<DataState<TData, TError, TDataInitial>>;
  getEntries: (filters) => UseQueryEntry<unknown, unknown, unknown>[];
  getQueryData: <TData>(key) => undefined | TData;
  invalidate: (entry) => void;
  invalidateQueries: (filters?) => Promise<unknown>;
  refresh: <TData, TError, TDataInitial>(entry, options) => Promise<DataState<TData, TError, TDataInitial>>;
  remove: (entry) => void;
  setEntryState: <TData, TError, TDataInitial>(entry, state) => void;
  setQueriesData: <TData>(filters, updater) => void;
  setQueryData: <TData>(key, data) => void;
  track: (entry, effect) => void;
  untrack: (entry, effect) => void;
}, never>, Pick<{
  caches: Ref<EntryMap<UseQueryEntry<unknown, unknown, unknown>>, EntryMap<UseQueryEntry<unknown, unknown, unknown>>>;
  cancel: (entry, reason?) => void;
  cancelQueries: (filters?, reason?) => void;
  create: <TData, TError, TDataInitial>(key, options, initialData?, error, when) => UseQueryEntry<TData, TError, TDataInitial>;
  ensure: <TData, TError, TDataInitial>(opts, previousEntry?) => UseQueryEntry<TData, TError, TDataInitial>;
  ensureDefinedQuery: <T>(fn) => DefineQueryEntry;
  extend: <TData, TError>(_entry) => void;
  fetch: <TData, TError, TDataInitial>(entry, options) => Promise<DataState<TData, TError, TDataInitial>>;
  getEntries: (filters) => UseQueryEntry<unknown, unknown, unknown>[];
  getQueryData: <TData>(key) => undefined | TData;
  invalidate: (entry) => void;
  invalidateQueries: (filters?) => Promise<unknown>;
  refresh: <TData, TError, TDataInitial>(entry, options) => Promise<DataState<TData, TError, TDataInitial>>;
  remove: (entry) => void;
  setEntryState: <TData, TError, TDataInitial>(entry, state) => void;
  setQueriesData: <TData>(filters, updater) => void;
  setQueryData: <TData>(key, data) => void;
  track: (entry, effect) => void;
  untrack: (entry, effect) => void;
}, 
  | "cancel"
  | "create"
  | "ensure"
  | "remove"
  | "setEntryState"
  | "getEntries"
  | "untrack"
  | "ensureDefinedQuery"
  | "setQueryData"
  | "setQueriesData"
  | "getQueryData"
  | "invalidateQueries"
  | "cancelQueries"
  | "invalidate"
  | "fetch"
  | "refresh"
  | "extend"
| "track">>;

Composable to get the cache of the queries. As any other composable, it can be used inside the setup function of a component, within another composable, or in injectable contexts like stores and navigation guards.