Skip to content

@pinia/root / pinia / SubscriptionCallbackMutationPatchObject

SubscriptionCallbackMutationPatchObject<S>

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

Extends

Type Parameters

S

Properties

events

ts
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

ts
payload: _DeepPartial<UnwrapRef<S>>;

Object passed to store.$patch().


storeId

ts
storeId: string;

id of the store doing the mutation.

Inherited from

_SubscriptionCallbackMutationBase.storeId


type

ts
type: patchObject;

Type of the mutation.

Overrides

_SubscriptionCallbackMutationBase.type

Released under the MIT License.