@empathyco/x-components
Version:
Empathy X Components
28 lines (17 loc) • 872 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [XComponentBusAPI](./x-components.xcomponentbusapi.md)
## XComponentBusAPI interface
API for emitting and subscribing to events of the .
**Signature:**
```typescript
export interface XComponentBusAPI
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [on](./x-components.xcomponentbusapi.on.md) | | XBus<[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, [WireMetadata](./x-components.wiremetadata.md)<!-- -->>\['on'\] | |
## Methods
| Method | Description |
| --- | --- |
| [emit(event)](./x-components.xcomponentbusapi.emit.md) | |
| [emit(event, payload, metadata)](./x-components.xcomponentbusapi.emit_1.md) | |