UNPKG

@empathyco/x-components

Version:
97 lines (43 loc) 1.22 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [EmittedData](./x-components.emitteddata.md) ## EmittedData interface Represents an object containing the data emitted by an event. **Signature:** ```typescript export interface EmittedData<SomeEvents extends Dictionary, SomeEvent extends keyof SomeEvents, SomeEventMetadata extends Dictionary> ``` ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> [event](./x-components.emitteddata.event.md) </td><td> </td><td> SomeEvent </td><td> The event name. </td></tr> <tr><td> [eventPayload](./x-components.emitteddata.eventpayload.md) </td><td> </td><td> [EventPayload](./x-components.eventpayload.md)<!-- -->&lt;SomeEvents, SomeEvent&gt; </td><td> The event payload. </td></tr> <tr><td> [metadata](./x-components.emitteddata.metadata.md) </td><td> </td><td> SomeEventMetadata </td><td> The event extra data. </td></tr> </tbody></table>