Interface IEventDefinition<TPayload>

interface IEventDefinition<TPayload> {
    id: string;
    meta?: IEventMeta;
    payloadSchema?: IValidationSchema<TPayload>;
    tags?: TagType[];
}

Type Parameters

TPayload = void

Hierarchy (view full)

IEventDefinition
- IEvent

Index

Properties

id meta? payloadSchema? tags?

Properties

id

id: string

`Optional`meta

meta?: IEventMeta

`Optional`payloadSchema

payloadSchema?: IValidationSchema<TPayload>

Optional validation schema for runtime payload validation. When provided, event payload will be validated when emitted.

`Optional`tags

tags?: TagType[]