IModelAction

Model Actions are translation functions between Diff and underlying resources. These actions can translate a specific type of Diff into individual resources.

Index

Properties

• ACTION_NAME

Methods

• collectInput
• filter
• handle

Properties

readonlyACTION_NAME

ACTION_NAME: string

The name of the action. It can be used to easily identify an action and its purpose.

Methods

collectInput

• collectInput(diff: Diff): string[]

• This function contains the list of inputs to ask before processing the diff. A missing input key will not be populated in the inputs provided to the action.

  ---

  Parameters

  • diff: Diff

  Returns string[]

filter

• filter(diff: Diff): boolean

• This function determines if the handle is applicable to the diff.

  ---

  Parameters

  • diff: Diff

  Returns boolean

handle

• handle(diff: Diff, actionInputs: ActionInputs, actionOutputs: ActionOutputs): Promise<ActionOutputs>

• This function contains the logic to apply the diff(s) to the underlying infrastructure.

  ---

  Parameters

  • diff: Diff

  • actionInputs: ActionInputs

  • actionOutputs: ActionOutputs

  Returns Promise<ActionOutputs>