Skip to main content

AppUnlockingEvent

This event is emitted before the app lock is released. A listener that returns a promise is awaited, so what it writes lands in the run's record before the record is sealed. A listener that fails keeps the lock held.

@group

Events/State

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • Parameters

    • optionalname: string

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

    • optionalpayload: { lockId: string }

      The event's data.

      • lockId: string

    Returns AppUnlockingEvent

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

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

Type declaration

  • lockId: string
Page Options