TerraformCommandStartedEvent

This event is emitted before a terraform/terragrunt command is invoked.

@group

Events/Terraform

Hierarchy

• TerraformEvent<{ command: string; dir: string }>
  • TerraformCommandStartedEvent

Index

Constructors

• constructor

Properties

• header
• name
• payload

Constructors

constructor

• TerraformCommandStartedEvent(name?: string, payload?: { command: string; dir: string }): TerraformCommandStartedEvent

• Inherited from TerraformEvent.constructor

  Parameters

  • optionalname: string

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

  • optionalpayload: { command: string; dir: string }

    The event's data.

  • command: string

  • dir: string

  Returns TerraformCommandStartedEvent

Properties

readonlyinheritedheader

header: { sequence: number; timestamp: number }

Inherited from TerraformEvent.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 TerraformEvent.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: { command: string; dir: string }

Inherited from TerraformEvent.payload

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

---

Type declaration

• command: string

• dir: string