Module "index"

Index

Type aliases

EventData

Functions

Type aliases

EventData

EventData<T>: { correlationId: string; data: T }

Type parameters

T

Type declaration

correlationId: string
data: T

Functions

assertEventData

assertEventData(value: unknown): assertsvalue is EventData

- Defined in index.ts:41
Asserts that the given value is compatible with EventData, otherwise throws ane Error.

throws

{Error}

Parameters
- value: unknown
Returns assertsvalue is EventData

Const isEventData

isEventData(value: unknown): value is EventData

- Defined in index.ts:17
Checks if the given value is compatible with EventData.

Parameters
- value: unknown
Returns value is EventData

Const newEventData

newEventData<T>(eventData: EventData<T>): EventData<T>

- Defined in index.ts:11
Returns new EventData.

Type parameters
- T
Parameters
- eventData: EventData<T>
Returns EventData<T>

Const parseEventData

parseEventData(value: unknown): EventData

- Defined in index.ts:31
Returns the given value as EventData if it is valid, otherwise throws an Error.

throws

{Error}

Parameters
- value: unknown
Returns EventData

Generated using TypeDoc