Skip to main content

CommandStartedEvent

This event is emitted when a command begins.

@group

Events/Command

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • Parameters

    • optionalname: string

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

    • optionalpayload: { command: string }

      The event's data.

      • command: string

    Returns CommandStartedEvent

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: { command: string }

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

Type declaration

  • command: string
Page Options