@empathyco/x-components/docs/API-reference/api/x-components.xprioritybus.on.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; [on](./x-components.xprioritybus.on.md)

## XPriorityBus.on() method

Retrieves an observable for the event. See [XBus.on](./x-components.xbus.on.md)<!-- -->.

**Signature:**

```typescript
on<SomeEvent extends keyof SomeEvents>(event: SomeEvent, withMetadata?: boolean): typeof withMetadata extends true ? Observable<SubjectPayload<EventPayload<SomeEvents, SomeEvent>, SomeEventMetadata>> : Observable<EventPayload<SomeEvents, SomeEvent>>;
```

## 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 retrieve the observable for.


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

withMetadata


</td><td>

boolean


</td><td>

_(Optional)_ Option to retrieve an observable with extra data about the event.


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

**Returns:**

typeof withMetadata extends true ? Observable&lt;[SubjectPayload](./x-components.subjectpayload.md)<!-- -->&lt;[EventPayload](./x-components.eventpayload.md)<!-- -->&lt;SomeEvents, SomeEvent&gt;, SomeEventMetadata&gt;&gt; : Observable&lt;[EventPayload](./x-components.eventpayload.md)<!-- -->&lt;SomeEvents, SomeEvent&gt;&gt;

The emitter for the event passed.