API Documentation / pinia / StoreDefinition

Interface: StoreDefinition<Id, S, G, A>

pinia.StoreDefinition

Type parameters

NameType
Idextends string = string
Sextends StateTree = StateTree
G_GettersTree<S>
A_ActionsTree

Callable

StoreDefinition

StoreDefinition(pinia?, hot?): Store<Id, S, G, A>

Returns a store, creates it if necessary.

Parameters

NameTypeDescription
pinia?null | PiniaPinia instance to retrieve the store
hot?StoreGenericdev only hot module replacement

Returns

Store<Id, S, G, A>

Properties

$id

$id: Id

Id of the store. Used by map helpers.