API Documentation / pinia / SubscriptionCallbackMutationPatchObject

Interface: SubscriptionCallbackMutationPatchObject<S> ​

pinia.SubscriptionCallbackMutationPatchObject

Context passed to a subscription callback when store.$patch() is called with an object.

Type parameters ​

Hierarchy ​

• _SubscriptionCallbackMutationBase

  ↳ SubscriptionCallbackMutationPatchObject

Properties ​

events ​

• events: DebuggerEvent[]

🔴 DEV ONLY, DO NOT use for production code. Different mutation calls. Comes from https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in devtools and plugins during development only.

Overrides ​

_SubscriptionCallbackMutationBase.events

payload ​

• payload: _DeepPartial<S>

Object passed to store.$patch().

storeId ​

• storeId: string

id of the store doing the mutation.

Inherited from ​

_SubscriptionCallbackMutationBase.storeId

type ​

• type: patchObject

Type of the mutation.

Overrides ​

_SubscriptionCallbackMutationBase.type