Class DomainEvent

An event passed from an EventHandler to a Subscriber

Usually this will not be created manually but automatically while dispatching events at the EventHandler.

This event will be provided at EventHandler.subscribe(event => ...).

Type Parameters

  • Payload

Hierarchy

Accessors

name payload timestamp

Methods

toJSON

Accessors

name

  • get name(): string

  • 💬 The name of the EventHandler which dispatched this event

    Returns string

payload

  • get payload(): Payload

  • 💬 the payload which was given while dispatching the event

    Returns Payload

timestamp

  • get timestamp(): Date

  • 💬 the Date this event was dispatched at the EventHandler

    Returns Date

Methods

toJSON

  • 💬 reduces the Serializable to its private ("underscored") attributes.

    All non-underscored attributes and methods will be omitted. This method overrides the built-in toJSON() which is primarily used in JSON.stringify()

    Returns

    an object containing all private attributes

    Type Parameters

    Returns Record<Key extends `_${X}` ? X : never, Value>

Theme

Generated using TypeDoc