Skip to content

createEvent

API reference for createEvent

@delta-base/toolkit


createEvent<EventType, EventData>(type, data, metadata?): Event<EventType, EventData, undefined | DefaultRecord>

Simple event creation with automatic type inference

EventType extends string

EventData extends DefaultRecord

EventType

The event type identifier

EventData

The event payload data

DefaultRecord

Optional event metadata

Event<EventType, EventData, undefined | DefaultRecord>

A properly typed event instance

const userRegistered = createEvent('UserRegistered', {
userId: 'user-123',
email: 'user@example.com'
});