Pinia Colada

Appearance

Complete guide to

Mastering Pinia

written by its creator

API Documentation / @pinia/colada / isQueryCache

Function: isQueryCache() ​

ts
function isQueryCache(cache): cache is Store<"_pc_query", Pick<{ caches: Ref<Map<string, UseQueryEntry<unknown, unknown, unknown>>, Map<string, UseQueryEntry<unknown, unknown, unknown>>>; cancel: (entry: UseQueryEntry, reason?: unknown) => void; cancelQueries: (filters?: UseQueryEntryFilter, reason?: unknown) => void; create: (key: EntryKey, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>, initialData?: TDataInitial, error: null | TError, when: number) => UseQueryEntry<TData, TError, TDataInitial>; ensure: (opts: UseQueryOptions<TData, TError, TDataInitial>, previousEntry?: UseQueryEntry<TData, TError, TDataInitial>) => UseQueryEntry<TData, TError, TDataInitial>; ensureDefinedQuery: (fn: () => T) => DefineQueryEntry; extend: (_entry: UseQueryEntry<TData, TError>) => void; fetch: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; getEntries: (filters: UseQueryEntryFilter) => UseQueryEntry<unknown, unknown, unknown>[]; getQueryData: (key: EntryKeyTagged<TData>) => undefined | TData; invalidate: (entry: UseQueryEntry) => void; invalidateQueries: (filters?: UseQueryEntryFilter, refetchActive: boolean | "all") => Promise<unknown>; refresh: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; remove: (entry: UseQueryEntry) => void; setEntryState: (entry: UseQueryEntry<TData, TError, TDataInitial>, state: DataState<NoInfer<TData>, NoInfer<TError>, NoInfer<TDataInitial>>) => void; setQueriesData: (filters: UseQueryEntryFilter, updater: (previous: undefined | TData) => TData) => void; setQueryData: (key: EntryKeyTagged<TData>, data: TData | ((oldData: undefined | TData) => TData)) => void; track: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void; untrack: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void }, "caches" | "_s">, Pick<{ caches: Ref<Map<string, UseQueryEntry<unknown, unknown, unknown>>, Map<string, UseQueryEntry<unknown, unknown, unknown>>>; cancel: (entry: UseQueryEntry, reason?: unknown) => void; cancelQueries: (filters?: UseQueryEntryFilter, reason?: unknown) => void; create: (key: EntryKey, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>, initialData?: TDataInitial, error: null | TError, when: number) => UseQueryEntry<TData, TError, TDataInitial>; ensure: (opts: UseQueryOptions<TData, TError, TDataInitial>, previousEntry?: UseQueryEntry<TData, TError, TDataInitial>) => UseQueryEntry<TData, TError, TDataInitial>; ensureDefinedQuery: (fn: () => T) => DefineQueryEntry; extend: (_entry: UseQueryEntry<TData, TError>) => void; fetch: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; getEntries: (filters: UseQueryEntryFilter) => UseQueryEntry<unknown, unknown, unknown>[]; getQueryData: (key: EntryKeyTagged<TData>) => undefined | TData; invalidate: (entry: UseQueryEntry) => void; invalidateQueries: (filters?: UseQueryEntryFilter, refetchActive: boolean | "all") => Promise<unknown>; refresh: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; remove: (entry: UseQueryEntry) => void; setEntryState: (entry: UseQueryEntry<TData, TError, TDataInitial>, state: DataState<NoInfer<TData>, NoInfer<TError>, NoInfer<TDataInitial>>) => void; setQueriesData: (filters: UseQueryEntryFilter, updater: (previous: undefined | TData) => TData) => void; setQueryData: (key: EntryKeyTagged<TData>, data: TData | ((oldData: undefined | TData) => TData)) => void; track: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void; untrack: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void }, never>, Pick<{ caches: Ref<Map<string, UseQueryEntry<unknown, unknown, unknown>>, Map<string, UseQueryEntry<unknown, unknown, unknown>>>; cancel: (entry: UseQueryEntry, reason?: unknown) => void; cancelQueries: (filters?: UseQueryEntryFilter, reason?: unknown) => void; create: (key: EntryKey, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>, initialData?: TDataInitial, error: null | TError, when: number) => UseQueryEntry<TData, TError, TDataInitial>; ensure: (opts: UseQueryOptions<TData, TError, TDataInitial>, previousEntry?: UseQueryEntry<TData, TError, TDataInitial>) => UseQueryEntry<TData, TError, TDataInitial>; ensureDefinedQuery: (fn: () => T) => DefineQueryEntry; extend: (_entry: UseQueryEntry<TData, TError>) => void; fetch: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; getEntries: (filters: UseQueryEntryFilter) => UseQueryEntry<unknown, unknown, unknown>[]; getQueryData: (key: EntryKeyTagged<TData>) => undefined | TData; invalidate: (entry: UseQueryEntry) => void; invalidateQueries: (filters?: UseQueryEntryFilter, refetchActive: boolean | "all") => Promise<unknown>; refresh: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; remove: (entry: UseQueryEntry) => void; setEntryState: (entry: UseQueryEntry<TData, TError, TDataInitial>, state: DataState<NoInfer<TData>, NoInfer<TError>, NoInfer<TDataInitial>>) => void; setQueriesData: (filters: UseQueryEntryFilter, updater: (previous: undefined | TData) => TData) => void; setQueryData: (key: EntryKeyTagged<TData>, data: TData | ((oldData: undefined | TData) => TData)) => void; track: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void; untrack: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void }, "cancel" | "create" | "ensure" | "remove" | "setEntryState" | "getEntries" | "untrack" | "ensureDefinedQuery" | "setQueryData" | "setQueriesData" | "getQueryData" | "invalidateQueries" | "cancelQueries" | "invalidate" | "fetch" | "refresh" | "extend" | "track">>;

Checks if the given object is a query cache. Used in SSR to apply custom serialization.

Parameters ​

cache ​

unknown

the object to check

Returns ​

cache is Store<"_pc_query", Pick<{ caches: Ref<Map<string, UseQueryEntry<unknown, unknown, unknown>>, Map<string, UseQueryEntry<unknown, unknown, unknown>>>; cancel: (entry: UseQueryEntry, reason?: unknown) => void; cancelQueries: (filters?: UseQueryEntryFilter, reason?: unknown) => void; create: (key: EntryKey, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>, initialData?: TDataInitial, error: null | TError, when: number) => UseQueryEntry<TData, TError, TDataInitial>; ensure: (opts: UseQueryOptions<TData, TError, TDataInitial>, previousEntry?: UseQueryEntry<TData, TError, TDataInitial>) => UseQueryEntry<TData, TError, TDataInitial>; ensureDefinedQuery: (fn: () => T) => DefineQueryEntry; extend: (_entry: UseQueryEntry<TData, TError>) => void; fetch: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; getEntries: (filters: UseQueryEntryFilter) => UseQueryEntry<unknown, unknown, unknown>[]; getQueryData: (key: EntryKeyTagged<TData>) => undefined | TData; invalidate: (entry: UseQueryEntry) => void; invalidateQueries: (filters?: UseQueryEntryFilter, refetchActive: boolean | "all") => Promise<unknown>; refresh: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; remove: (entry: UseQueryEntry) => void; setEntryState: (entry: UseQueryEntry<TData, TError, TDataInitial>, state: DataState<NoInfer<TData>, NoInfer<TError>, NoInfer<TDataInitial>>) => void; setQueriesData: (filters: UseQueryEntryFilter, updater: (previous: undefined | TData) => TData) => void; setQueryData: (key: EntryKeyTagged<TData>, data: TData | ((oldData: undefined | TData) => TData)) => void; track: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void; untrack: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void }, "caches" | "_s">, Pick<{ caches: Ref<Map<string, UseQueryEntry<unknown, unknown, unknown>>, Map<string, UseQueryEntry<unknown, unknown, unknown>>>; cancel: (entry: UseQueryEntry, reason?: unknown) => void; cancelQueries: (filters?: UseQueryEntryFilter, reason?: unknown) => void; create: (key: EntryKey, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>, initialData?: TDataInitial, error: null | TError, when: number) => UseQueryEntry<TData, TError, TDataInitial>; ensure: (opts: UseQueryOptions<TData, TError, TDataInitial>, previousEntry?: UseQueryEntry<TData, TError, TDataInitial>) => UseQueryEntry<TData, TError, TDataInitial>; ensureDefinedQuery: (fn: () => T) => DefineQueryEntry; extend: (_entry: UseQueryEntry<TData, TError>) => void; fetch: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; getEntries: (filters: UseQueryEntryFilter) => UseQueryEntry<unknown, unknown, unknown>[]; getQueryData: (key: EntryKeyTagged<TData>) => undefined | TData; invalidate: (entry: UseQueryEntry) => void; invalidateQueries: (filters?: UseQueryEntryFilter, refetchActive: boolean | "all") => Promise<unknown>; refresh: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; remove: (entry: UseQueryEntry) => void; setEntryState: (entry: UseQueryEntry<TData, TError, TDataInitial>, state: DataState<NoInfer<TData>, NoInfer<TError>, NoInfer<TDataInitial>>) => void; setQueriesData: (filters: UseQueryEntryFilter, updater: (previous: undefined | TData) => TData) => void; setQueryData: (key: EntryKeyTagged<TData>, data: TData | ((oldData: undefined | TData) => TData)) => void; track: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void; untrack: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void }, never>, Pick<{ caches: Ref<Map<string, UseQueryEntry<unknown, unknown, unknown>>, Map<string, UseQueryEntry<unknown, unknown, unknown>>>; cancel: (entry: UseQueryEntry, reason?: unknown) => void; cancelQueries: (filters?: UseQueryEntryFilter, reason?: unknown) => void; create: (key: EntryKey, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>, initialData?: TDataInitial, error: null | TError, when: number) => UseQueryEntry<TData, TError, TDataInitial>; ensure: (opts: UseQueryOptions<TData, TError, TDataInitial>, previousEntry?: UseQueryEntry<TData, TError, TDataInitial>) => UseQueryEntry<TData, TError, TDataInitial>; ensureDefinedQuery: (fn: () => T) => DefineQueryEntry; extend: (_entry: UseQueryEntry<TData, TError>) => void; fetch: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; getEntries: (filters: UseQueryEntryFilter) => UseQueryEntry<unknown, unknown, unknown>[]; getQueryData: (key: EntryKeyTagged<TData>) => undefined | TData; invalidate: (entry: UseQueryEntry) => void; invalidateQueries: (filters?: UseQueryEntryFilter, refetchActive: boolean | "all") => Promise<unknown>; refresh: (entry: UseQueryEntry<TData, TError, TDataInitial>, options: null | UseQueryOptionsWithDefaults<TData, TError, TDataInitial>) => Promise<DataState<TData, TError, TDataInitial>>; remove: (entry: UseQueryEntry) => void; setEntryState: (entry: UseQueryEntry<TData, TError, TDataInitial>, state: DataState<NoInfer<TData>, NoInfer<TError>, NoInfer<TDataInitial>>) => void; setQueriesData: (filters: UseQueryEntryFilter, updater: (previous: undefined | TData) => TData) => void; setQueryData: (key: EntryKeyTagged<TData>, data: TData | ((oldData: undefined | TData) => TData)) => void; track: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void; untrack: (entry: UseQueryEntry, effect: undefined | null | EffectScope | ComponentInternalInstance) => void }, "cancel" | "create" | "ensure" | "remove" | "setEntryState" | "getEntries" | "untrack" | "ensureDefinedQuery" | "setQueryData" | "setQueriesData" | "getQueryData" | "invalidateQueries" | "cancelQueries" | "invalidate" | "fetch" | "refresh" | "extend" | "track">>

See ​

Released under the MIT License.

Copyright © 2023-present Eduardo San Martin Morote