API Documentation • Docs

---

API Documentation / pinia

pinia

Index

Enumerations

• MutationType

Interfaces

• DefineSetupStoreOptions
• DefineStoreOptions
• DefineStoreOptionsBase
• DefineStoreOptionsInPlugin
• MapStoresCustomization
• Pinia
• PiniaCustomProperties
• PiniaCustomStateProperties
• PiniaPlugin
• PiniaPluginContext
• SetupStoreDefinition
• StoreDefinition
• StoreProperties
• SubscriptionCallbackMutationDirect
• SubscriptionCallbackMutationPatchFunction
• SubscriptionCallbackMutationPatchObject
• _StoreOnActionListenerContext
• _StoreWithState
• _SubscriptionCallbackMutationBase

Type Aliases

• PiniaStorePlugin
• StateTree
• Store
• StoreActions
• StoreGeneric
• StoreGetters
• StoreOnActionListener
• StoreOnActionListenerContext
• StoreState
• SubscriptionCallback
• SubscriptionCallbackMutation
• _ActionsTree
• _Awaited
• _DeepPartial
• _ExtractActionsFromSetupStore
• _ExtractActionsFromSetupStore_Keys
• _ExtractGettersFromSetupStore
• _ExtractGettersFromSetupStore_Keys
• _ExtractStateFromSetupStore
• _ExtractStateFromSetupStore_Keys
• _GettersTree
• _MapActionsObjectReturn
• _MapActionsReturn
• _MapStateObjectReturn
• _MapStateReturn
• _MapWritableStateObjectReturn
• _MapWritableStateReturn
• _Method
• _Spread
• _StoreObject
• _StoreWithActions
• _StoreWithGetters
• _UnwrapAll

Variables

• PiniaVuePlugin

Functions

• acceptHMRUpdate
• createPinia
• defineStore
• disposePinia
• getActivePinia
• mapActions
• mapGetters
• mapState
• mapStores
• mapWritableState
• setActivePinia
• setMapStoreSuffix
• skipHydrate
• storeToRefs