createEvent
API reference for createEvent
Function: createEvent()
Section titled “Function: createEvent()”createEvent<
EventType
,EventData
>(type
,data
,metadata?
):Event
<EventType
,EventData
,undefined
|DefaultRecord
>
Simple event creation with automatic type inference
Type Parameters
Section titled “Type Parameters”EventType
Section titled “EventType”EventType
extends string
EventData
Section titled “EventData”EventData
extends DefaultRecord
Parameters
Section titled “Parameters”EventType
The event type identifier
EventData
The event payload data
metadata?
Section titled “metadata?”Optional event metadata
Returns
Section titled “Returns”Event
<EventType
, EventData
, undefined
| DefaultRecord
>
A properly typed event instance
Example
Section titled “Example”const userRegistered = createEvent('UserRegistered', { userId: 'user-123', email: 'user@example.com'});