[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [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: Event, withMetadata: Metadata) => { subscribe: (callback: (payload: Metadata extends true ? import("..").SubjectPayload, import("..").WireMetadata> : import("..").EventPayload) => void) => void; }; emit: (event: Event, payload?: import("..").XEventPayload, metadata?: Omit) => Promise>; }; ``` **Returns:** import("./use-alias-api").[UseAliasAPI](./x-components.usealiasapi.md) & { on: <Event extends import("..").[XEvent](./x-components.xevent.md), Metadata extends boolean>(event: Event, withMetadata: Metadata) => { subscribe: (callback: (payload: Metadata extends true ? import("..").[SubjectPayload](./x-components.subjectpayload.md)<import("..").[EventPayload](./x-components.eventpayload.md)<import("..").[XEventsTypes](./x-components.xeventstypes.md), Event>, import("..").[WireMetadata](./x-components.wiremetadata.md)> : import("..").[EventPayload](./x-components.eventpayload.md)<import("..").[XEventsTypes](./x-components.xeventstypes.md), Event>) => void) => void; }; emit: <Event extends import("..").[XEvent](./x-components.xevent.md)>(event: Event, payload?: import("..").[XEventPayload](./x-components.xeventpayload.md)<Event>, metadata?: Omit<import("..").[WireMetadata](./x-components.wiremetadata.md), "moduleName">) => Promise<import("..").[EmittedData](./x-components.emitteddata.md)<import("..").[XEventsTypes](./x-components.xeventstypes.md), Event, import("..").[WireMetadata](./x-components.wiremetadata.md)>>; } The `$x` object from the current component instance.