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. Array for patch calls.

Defined in #

pinia/src/types.ts:110

payload #

• payload: _DeepPartial<S>

Object passed to store.$patch().

Defined in #

pinia/src/types.ts:115

storeId #

• storeId: string

id of the store doing the mutation.

Inherited from #

_SubscriptionCallbackMutationBase.storeId

Defined in #

pinia/src/types.ts:81

type #

• type: patchObject

Type of the mutation.

Overrides #

_SubscriptionCallbackMutationBase.type

Defined in #

pinia/src/types.ts:105