Skip to main content

AppLockTakenEvent

This event is emitted when the app lock is taken, or resumed with its id. A provider sharing state names where a resume took the state directory from: the directory the lock was taken in (directory), what the run uploaded so far (run), or the newest sealed state, because the run uploaded nothing (sealed).

@group

Events/State

Hierarchy

  • StateEvent<{ commitId?: string; lockId: string; resumed: boolean; resumedFrom?: directory | run | sealed }>
    • AppLockTakenEvent

Index

Constructors

Properties

Constructors

constructor

  • AppLockTakenEvent(name?: string, payload?: { commitId?: string; lockId: string; resumed: boolean; resumedFrom?: directory | run | sealed }): AppLockTakenEvent

  • Parameters

    • optionalname: string

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

    • optionalpayload: { commitId?: string; lockId: string; resumed: boolean; resumedFrom?: directory | run | sealed }

      The event's data.

      • optionalcommitId: string
      • lockId: string
      • resumed: boolean
      • optionalresumedFrom: directory | run | sealed

    Returns AppLockTakenEvent

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: { commitId?: string; lockId: string; resumed: boolean; resumedFrom?: directory | run | sealed }

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

Type declaration

  • optionalcommitId?: string
  • lockId: string
  • resumed: boolean
  • optionalresumedFrom?: directory | run | sealed
Page Options