@empathyco/x-components
Version:
Empathy X Components
24 lines (15 loc) • 1.19 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [XModule](./x-components.xmodule.md)
## XModule interface
A group of a wiring configuration, a store module, and side effects.
**Signature:**
```typescript
export interface XModule<StoreModule extends AnyXStoreModule>
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [name](./x-components.xmodule.name.md) | | [XModuleName](./x-components.xmodulename.md) | A unique name that identifies this XModule. |
| [storeEmitters](./x-components.xmodule.storeemitters.md) | | [StoreEmitters](./x-components.storeemitters.md)<!-- --><StoreModule> | Watchers for the store module that will emit an XEvent when changed. |
| [storeModule](./x-components.xmodule.storemodule.md) | | StoreModule | The Vuex Store module associated to this module. |
| [wiring](./x-components.xmodule.wiring.md) | | Partial<[Wiring](./x-components.wiring.md)<!-- -->> | The wiring associated to this module. It must only access to the store module of this XModule. |