@empathyco/x-components/docs/API-reference/api/x-components.xprioritybus.emit.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XPriorityBus](./x-components.xprioritybus.md) &gt; [emit](./x-components.xprioritybus.emit.md)

## XPriorityBus.emit() method

Emits an event. See [XBus.emit](./x-components.xbus.emit.md)<!-- -->.

**Signature:**

```typescript
emit<SomeEvent extends keyof SomeEvents>(event: SomeEvent, payload?: EventPayload<SomeEvents, SomeEvent>, metadata?: SomeEventMetadata): Promise<EmittedData<SomeEvents, SomeEvent, SomeEventMetadata>>;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

event


</td><td>

SomeEvent


</td><td>

Event to be emitted.


</td></tr>
<tr><td>

payload


</td><td>

[EventPayload](./x-components.eventpayload.md)<!-- -->&lt;SomeEvents, SomeEvent&gt;


</td><td>

_(Optional)_ Event payload.


</td></tr>
<tr><td>

metadata


</td><td>

SomeEventMetadata


</td><td>

_(Optional)_ Extra event data.


</td></tr>
</tbody></table>

**Returns:**

Promise&lt;[EmittedData](./x-components.emitteddata.md)<!-- -->&lt;SomeEvents, SomeEvent, SomeEventMetadata&gt;&gt;

A promise that is resolved the moment the event is emitted.