@empathyco/x-components
Version:
Empathy X Components
14 lines • 926 B
TypeScript
/**
* Function which returns the `$x` object from the current component instance.
*
* @returns The `$x` object from the current component instance.
*
* @public
*/
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>>;
};
//# sourceMappingURL=use-$x.d.ts.map