createReadEvent
API reference for createReadEvent
Function: createReadEvent()
Section titled “Function: createReadEvent()”createReadEvent<
EventType>(inputEvent,streamId,streamPosition,globalPosition,eventId?,schemaVersion?,transactionId?,createdAt?):ReadEvent<EventType>
Create a ReadEvent (simulates what would come from event store) This is primarily for testing purposes
Type Parameters
Section titled “Type Parameters”EventType
Section titled “EventType”EventType extends Readonly<{ data: EventData; metadata?: PlatformEventMetadata; type: string; }>
Parameters
Section titled “Parameters”inputEvent
Section titled “inputEvent”EventType
The input event to convert
streamId
Section titled “streamId”string
The stream identifier
streamPosition
Section titled “streamPosition”number
The position in the stream
globalPosition
Section titled “globalPosition”number
The global position
eventId?
Section titled “eventId?”string
Optional event ID (generates UUID if not provided)
schemaVersion?
Section titled “schemaVersion?”string
Optional schema version (defaults to “1.0”)
transactionId?
Section titled “transactionId?”string
Optional transaction ID (generates UUID if not provided)
createdAt?
Section titled “createdAt?”string
Optional creation timestamp (defaults to current time)
Returns
Section titled “Returns”ReadEvent<EventType>
A ReadEvent instance for testing
Example
Section titled “Example”const event = createEvent('UserRegistered', { userId: '123' });const readEvent = createReadEvent(event, 'user-123', 1, 1);