API Documentation / @pinia/colada / isMutationCache

Function: isMutationCache()

function isMutationCache(cache): cache is Store<"_pc_mutation", Pick<{ caches: Ref<Map<string, UseMutationEntry<unknown, any, unknown, any>>, Map<string, UseMutationEntry<unknown, any, unknown, any>>>; create: (options: UseMutationOptions<TData, TVars, TError, TContext>, key?: EntryKey, vars?: TVars) => UseMutationEntry<TData, TVars, TError, TContext>; ensure: (entry: UseMutationEntry<TData, TVars, TError, TContext>, vars: NoInfer<TVars>) => UseMutationEntry<TData, TVars, TError, TContext>; ensureDefinedMutation: (fn: () => T) => unknown; extend: (_entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; get: (key: EntryKey) => UseMutationEntry<TData, TVars, TError, TContext> | undefined; getEntries: (filters: UseMutationEntryFilter) => UseMutationEntry<unknown, unknown, unknown, _EmptyObject>[]; mutate: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => Promise<TData>; remove: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; setEntryState: (entry: UseMutationEntry<TData, TVars, TError, TContext>, state: DataState<NoInfer<TData>, NoInfer<TError>>) => void; untrack: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void }, "caches" | "_s">, Pick<{ caches: Ref<Map<string, UseMutationEntry<unknown, any, unknown, any>>, Map<string, UseMutationEntry<unknown, any, unknown, any>>>; create: (options: UseMutationOptions<TData, TVars, TError, TContext>, key?: EntryKey, vars?: TVars) => UseMutationEntry<TData, TVars, TError, TContext>; ensure: (entry: UseMutationEntry<TData, TVars, TError, TContext>, vars: NoInfer<TVars>) => UseMutationEntry<TData, TVars, TError, TContext>; ensureDefinedMutation: (fn: () => T) => unknown; extend: (_entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; get: (key: EntryKey) => UseMutationEntry<TData, TVars, TError, TContext> | undefined; getEntries: (filters: UseMutationEntryFilter) => UseMutationEntry<unknown, unknown, unknown, _EmptyObject>[]; mutate: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => Promise<TData>; remove: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; setEntryState: (entry: UseMutationEntry<TData, TVars, TError, TContext>, state: DataState<NoInfer<TData>, NoInfer<TError>>) => void; untrack: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void }, never>, Pick<{ caches: Ref<Map<string, UseMutationEntry<unknown, any, unknown, any>>, Map<string, UseMutationEntry<unknown, any, unknown, any>>>; create: (options: UseMutationOptions<TData, TVars, TError, TContext>, key?: EntryKey, vars?: TVars) => UseMutationEntry<TData, TVars, TError, TContext>; ensure: (entry: UseMutationEntry<TData, TVars, TError, TContext>, vars: NoInfer<TVars>) => UseMutationEntry<TData, TVars, TError, TContext>; ensureDefinedMutation: (fn: () => T) => unknown; extend: (_entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; get: (key: EntryKey) => UseMutationEntry<TData, TVars, TError, TContext> | undefined; getEntries: (filters: UseMutationEntryFilter) => UseMutationEntry<unknown, unknown, unknown, _EmptyObject>[]; mutate: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => Promise<TData>; remove: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; setEntryState: (entry: UseMutationEntry<TData, TVars, TError, TContext>, state: DataState<NoInfer<TData>, NoInfer<TError>>) => void; untrack: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void }, "get" | "create" | "ensure" | "ensureDefinedMutation" | "mutate" | "remove" | "extend" | "setEntryState" | "getEntries" | "untrack">>;

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

Parameters

cache

unknown

the object to check

Returns

cache is Store<"_pc_mutation", Pick<{ caches: Ref<Map<string, UseMutationEntry<unknown, any, unknown, any>>, Map<string, UseMutationEntry<unknown, any, unknown, any>>>; create: (options: UseMutationOptions<TData, TVars, TError, TContext>, key?: EntryKey, vars?: TVars) => UseMutationEntry<TData, TVars, TError, TContext>; ensure: (entry: UseMutationEntry<TData, TVars, TError, TContext>, vars: NoInfer<TVars>) => UseMutationEntry<TData, TVars, TError, TContext>; ensureDefinedMutation: (fn: () => T) => unknown; extend: (_entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; get: (key: EntryKey) => UseMutationEntry<TData, TVars, TError, TContext> | undefined; getEntries: (filters: UseMutationEntryFilter) => UseMutationEntry<unknown, unknown, unknown, _EmptyObject>[]; mutate: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => Promise<TData>; remove: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; setEntryState: (entry: UseMutationEntry<TData, TVars, TError, TContext>, state: DataState<NoInfer<TData>, NoInfer<TError>>) => void; untrack: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void }, "caches" | "_s">, Pick<{ caches: Ref<Map<string, UseMutationEntry<unknown, any, unknown, any>>, Map<string, UseMutationEntry<unknown, any, unknown, any>>>; create: (options: UseMutationOptions<TData, TVars, TError, TContext>, key?: EntryKey, vars?: TVars) => UseMutationEntry<TData, TVars, TError, TContext>; ensure: (entry: UseMutationEntry<TData, TVars, TError, TContext>, vars: NoInfer<TVars>) => UseMutationEntry<TData, TVars, TError, TContext>; ensureDefinedMutation: (fn: () => T) => unknown; extend: (_entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; get: (key: EntryKey) => UseMutationEntry<TData, TVars, TError, TContext> | undefined; getEntries: (filters: UseMutationEntryFilter) => UseMutationEntry<unknown, unknown, unknown, _EmptyObject>[]; mutate: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => Promise<TData>; remove: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; setEntryState: (entry: UseMutationEntry<TData, TVars, TError, TContext>, state: DataState<NoInfer<TData>, NoInfer<TError>>) => void; untrack: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void }, never>, Pick<{ caches: Ref<Map<string, UseMutationEntry<unknown, any, unknown, any>>, Map<string, UseMutationEntry<unknown, any, unknown, any>>>; create: (options: UseMutationOptions<TData, TVars, TError, TContext>, key?: EntryKey, vars?: TVars) => UseMutationEntry<TData, TVars, TError, TContext>; ensure: (entry: UseMutationEntry<TData, TVars, TError, TContext>, vars: NoInfer<TVars>) => UseMutationEntry<TData, TVars, TError, TContext>; ensureDefinedMutation: (fn: () => T) => unknown; extend: (_entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; get: (key: EntryKey) => UseMutationEntry<TData, TVars, TError, TContext> | undefined; getEntries: (filters: UseMutationEntryFilter) => UseMutationEntry<unknown, unknown, unknown, _EmptyObject>[]; mutate: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => Promise<TData>; remove: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void; setEntryState: (entry: UseMutationEntry<TData, TVars, TError, TContext>, state: DataState<NoInfer<TData>, NoInfer<TError>>) => void; untrack: (entry: UseMutationEntry<TData, TVars, TError, TContext>) => void }, "get" | "create" | "ensure" | "ensureDefinedMutation" | "mutate" | "remove" | "extend" | "setEntryState" | "getEntries" | "untrack">>

See

MutationCache