@empathyco/x-components
Version:
Empathy X Components
26 lines (15 loc) • 852 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) > [emit](./x-components.xcomponentbusapi.emit_1.md)
## XComponentBusAPI.emit() method
**Signature:**
```typescript
emit<Event extends XEvent>(event: Event, payload: XEventPayload<Event>, metadata?: Omit<WireMetadata, 'moduleName' | 'origin' | 'location'>): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| event | Event | |
| payload | [XEventPayload](./x-components.xeventpayload.md)<!-- --><Event> | |
| metadata | Omit<[WireMetadata](./x-components.wiremetadata.md)<!-- -->, 'moduleName' \| 'origin' \| 'location'> | _(Optional)_ |
**Returns:**
void