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

## use$x() function

Function which returns the `$x` object from the current component instance.

**Signature:**

```typescript
export declare function use$x(): import("./use-alias-api").UseAliasAPI & {
    on: <Event_1 extends keyof import("..").XEventsTypes, Metadata extends boolean>(event: Event_1, withMetadata: Metadata) => {
        subscribe: (callback: (payload: Metadata extends true ? import("@empathyco/x-bus").SubjectPayload<import("@empathyco/x-bus").EventPayload<import("..").XEventsTypes, Event_1>, import("..").WireMetadata> : import("@empathyco/x-bus").EventPayload<import("..").XEventsTypes, Event_1>) => void) => void;
    };
    emit: <Event_2 extends keyof import("..").XEventsTypes>(event: Event_2, payload?: import("..").XEventPayload<Event_2> | undefined, metadata?: Omit<import("..").WireMetadata, "moduleName">) => Promise<import("@empathyco/x-bus").EmittedData<import("..").XEventsTypes, Event_2, import("..").WireMetadata>>;
};
```
**Returns:**

import("./use-alias-api").[UseAliasAPI](./x-components.usealiasapi.md) &amp; { on: &lt;Event\_1 extends keyof import("..").[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, Metadata extends boolean&gt;(event: Event\_1, withMetadata: Metadata) =&gt; { subscribe: (callback: (payload: Metadata extends true ? import("@empathyco/x-bus").SubjectPayload&lt;import("@empathyco/x-bus").EventPayload&lt;import("..").[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, Event\_1&gt;, import("..").[WireMetadata](./x-components.wiremetadata.md)<!-- -->&gt; : import("@empathyco/x-bus").EventPayload&lt;import("..").[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, Event\_1&gt;) =&gt; void) =&gt; void; }; emit: &lt;Event\_2 extends keyof import("..").[XEventsTypes](./x-components.xeventstypes.md)<!-- -->&gt;(event: Event\_2, payload?: import("..").[XEventPayload](./x-components.xeventpayload.md)<!-- -->&lt;Event\_2&gt; \| undefined, metadata?: Omit&lt;import("..").[WireMetadata](./x-components.wiremetadata.md)<!-- -->, "moduleName"&gt;) =&gt; Promise&lt;import("@empathyco/x-bus").EmittedData&lt;import("..").[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, Event\_2, import("..").[WireMetadata](./x-components.wiremetadata.md)<!-- -->&gt;&gt;; }

The `$x` object from the current component instance.