API Documentation / pinia / _StoreOnActionListenerContext

Interface: _StoreOnActionListenerContext<Store, ActionName, A>

pinia._StoreOnActionListenerContext

Actual type for StoreOnActionListenerContext. Exists for refactoring purposes. For internal use only. For internal use only

Type parameters

Name	Type
Store	Store
ActionName	extends string
A	A

Properties

after

• after: (callback: A extends Record<ActionName, _Method> ? (resolvedReturn: _Awaited<ReturnType<A[ActionName]>>) => void : () => void) => void

Type declaration

▸ (callback): void

Sets up a hook once the action is finished. It receives the return value of the action, if it's a Promise, it will be unwrapped.

Parameters

Name	Type
callback	A extends Record<ActionName, _Method> ? (resolvedReturn: _Awaited<ReturnType<A[ActionName]>>) => void : () => void

Returns

void

---

args

• args: A extends Record<ActionName, _Method> ? Parameters<A[ActionName]> : unknown[]

Parameters passed to the action

---

name

• name: ActionName

Name of the action

---

onError

• onError: (callback: (error: unknown) => void) => void

Type declaration

▸ (callback): void

Sets up a hook if the action fails. Return false to catch the error and stop it from propagating.

Parameters

Name	Type
callback	(error: unknown) => void

Returns

void

---

store

• store: Store

Store that is invoking the action