API Documentation / pinia / PiniaPlugin

Interface: PiniaPlugin

pinia.PiniaPlugin

Callable

PiniaPlugin

PiniaPlugin(context): void | Partial<PiniaCustomProperties<string, StateTree, _GettersTree<StateTree>, _ActionsTree> & PiniaCustomStateProperties<StateTree>>

Plugin to extend every store. Returns an object to extend the store or nothing.

Parameters

NameTypeDescription
contextPiniaPluginContext<string, StateTree, _GettersTree<StateTree>, _ActionsTree>Context

Returns

void | Partial<PiniaCustomProperties<string, StateTree, _GettersTree<StateTree>, _ActionsTree> & PiniaCustomStateProperties<StateTree>>