abstractStateEvent <T>

The superclass of the events about Octo's state: what was written, refreshed, locked, or unlocked.

@group

Events/State

Hierarchy

• Event<T>
  • StateEvent
    • AppLockRefusedEvent
    • AppLockTakenEvent
    • AppUnlockedEvent
    • AppUnlockingEvent
    • StateFilesSavedEvent
    • StateFilesSavingEvent
    • StateRefreshedEvent

Index

Constructors

• constructor

Properties

• header
• name
• payload

Constructors

constructor

• StateEvent<T>(name?: string, payload?: T): StateEvent<T>

• Inherited from Event.constructor

  Type parameters

  • T

  Parameters

  • optionalname: string

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

  • optionalpayload: T

    The event's data.

  Returns StateEvent<T>

Properties

readonlyinheritedheader

header: { sequence: number; timestamp: number }

Inherited from Event.header

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

Inherited from Event.name

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: T

Inherited from Event.payload

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