@empathyco/x-components
Version:
Empathy X Components
116 lines (51 loc) • 1.54 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
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[name](./x-components.xmodule.name.md)
</td><td>
</td><td>
[XModuleName](./x-components.xmodulename.md)
</td><td>
A unique name that identifies this XModule.
</td></tr>
<tr><td>
[storeEmitters](./x-components.xmodule.storeemitters.md)
</td><td>
</td><td>
[StoreEmitters](./x-components.storeemitters.md)<!-- --><StoreModule>
</td><td>
Watchers for the store module that will emit an XEvent when changed.
</td></tr>
<tr><td>
[storeModule](./x-components.xmodule.storemodule.md)
</td><td>
</td><td>
StoreModule
</td><td>
The Vuex Store module associated to this module.
</td></tr>
<tr><td>
[wiring](./x-components.xmodule.wiring.md)
</td><td>
</td><td>
Partial<[Wiring](./x-components.wiring.md)<!-- -->>
</td><td>
The wiring associated to this module. It must only access to the store module of this XModule.
</td></tr>
</tbody></table>