@empathyco/x-components
Version:
Empathy X Components
92 lines (41 loc) • 2.16 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [XActionContext](./x-components.xactioncontext.md)
## XActionContext interface
Type safe Vuex [Action](https://vuex.vuejs.org/api/#actions) context, with the local types of the module.
**Signature:**
```typescript
export interface XActionContext<State extends Dictionary, Getters extends Dictionary, Mutations extends MutationsDictionary<Mutations>, Actions extends ActionsDictionary<Actions>> extends ActionContext<State, RootXStoreState>
```
**Extends:** ActionContext<State, [RootXStoreState](./x-components.rootxstorestate.md)<!-- -->>
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[commit](./x-components.xactioncontext.commit.md)
</td><td>
</td><td>
(<MutationName extends [PropsWithType](./x-components.propswithtype.md)<!-- --><Mutations, () => void>>(mutation: MutationName) => void) & (<MutationName extends keyof Mutations>(mutation: MutationName, payload: [ExtractPayload](./x-components.extractpayload.md)<!-- --><Mutations\[MutationName\]>) => void)
</td><td>
</td></tr>
<tr><td>
[dispatch](./x-components.xactioncontext.dispatch.md)
</td><td>
</td><td>
(<ActionName extends [PropsWithType](./x-components.propswithtype.md)<!-- --><Actions, () => any>>(action: ActionName) => [ExtractActionReturn](./x-components.extractactionreturn.md)<!-- --><Actions\[ActionName\]>) & (<ActionName extends keyof Actions>(action: ActionName, payload: [ExtractPayload](./x-components.extractpayload.md)<!-- --><Actions\[ActionName\]>) => [ExtractActionReturn](./x-components.extractactionreturn.md)<!-- --><Actions\[ActionName\]>)
</td><td>
</td></tr>
<tr><td>
[getters](./x-components.xactioncontext.getters.md)
</td><td>
</td><td>
Getters
</td><td>
</td></tr>
</tbody></table>