Skip to main content

ModeFailedEvent

This event is emitted when a mode throws. The error is also re-thrown to the caller. A listener that returns a promise is awaited, so it can finish writing before the process exits.

@group

Events/Mode

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • Parameters

    • optionalname: string

      The subject of the event, when the event type alone does not identify it.

    • optionalpayload: ModeEventPayload & { durationInMs: number; error: Error }

      The event's data.

    Returns ModeFailedEvent

Properties

readonlyinheritedheader

header: { sequence: number; timestamp: number }

When the event was created. sequence counts every event this process created, so it orders two events created in the same millisecond, and events a late listener receives replayed.

Type declaration

  • sequence: number
  • timestamp: number

readonlyinheritedname

name: string

The subject of the event, when the event type alone does not identify it - e.g. the class name on a registration event. Empty otherwise.

readonlyinheritedpayload

payload: ModeEventPayload & { durationInMs: number; error: Error }

The event's data. Its shape is fixed by the event type.

Page Options