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

## XBus.on property

Retrieves an observable for an event.

**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>>;
```