Skip to main content

TerraformProcessStartedEvent

This event is emitted when octo starts a terraform or terragrunt process, before it writes anything. processId tells apart the processes of one octo process: a JSON plan runs a plan and a show in every folder.

@group

Events/Terraform

Hierarchy

  • TerraformEvent<{ args: string[]; binary: string; dir: string; processId: number }>
    • TerraformProcessStartedEvent

Index

Constructors

Properties

Constructors

constructor

  • TerraformProcessStartedEvent(name?: string, payload?: { args: string[]; binary: string; dir: string; processId: number }): TerraformProcessStartedEvent

  • Parameters

    • optionalname: string

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

    • optionalpayload: { args: string[]; binary: string; dir: string; processId: number }

      The event's data.

      • args: string[]
      • binary: string
      • dir: string
      • processId: number

    Returns TerraformProcessStartedEvent

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: { args: string[]; binary: string; dir: string; processId: number }

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

Type declaration

  • args: string[]
  • binary: string
  • dir: string
  • processId: number
Page Options