@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 extends import("..").XEvent, Metadata extends boolean>(event: Event, withMetadata: Metadata) => {
        subscribe: (callback: (payload: Metadata extends true ? import("..").SubjectPayload<import("..").EventPayload<import("..").XEventsTypes, Event>, import("..").WireMetadata> : import("..").EventPayload<import("..").XEventsTypes, Event>) => void) => void;
    };
    emit: <Event extends import("..").XEvent>(event: Event, payload?: import("..").XEventPayload<Event>, metadata?: Omit<import("..").WireMetadata, "moduleName">) => Promise<import("..").EmittedData<import("..").XEventsTypes, Event, import("..").WireMetadata>>;
};
```
**Returns:**

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

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