Class VariableSetter

A VariableHandler that will set the given variable to the given value, unless there already is a value for the variable and override is false.

Hierarchy

VariableHandler
- VariableSetter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new VariableSetter(variable: string, value: string, override?: boolean): VariableSetter

Inherited from VariableHandler.constructor
- Defined in src/pods/generate/variables/VariableSetter.ts:11
Parameters
- variable: string
- value: string
- override: boolean = false
Returns VariableSetter

Properties

Private Readonly override

override: boolean

Private Readonly value

value: string

Private Readonly variable

variable: string

Methods

canHandle

canHandle(input: { identifier: ResourceIdentifier; settings: PodSettings }): Promise<void>

Inherited from VariableHandler.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:13
Checks if the input data can be handled by this class. Throws an error if it can't handle the data.

Parameters
- input: { identifier: ResourceIdentifier; settings: PodSettings }
  
  Input data that could potentially be handled.
  - identifier: ResourceIdentifier
  - settings: PodSettings
Returns Promise<void>

A promise resolving if the input can be handled, rejecting with an Error if not.

handle

handle(__namedParameters: { settings: PodSettings }): Promise<void>

Overrides VariableHandler.handle
- Defined in src/pods/generate/variables/VariableSetter.ts:20
Parameters
- __namedParameters: { settings: PodSettings }
  - settings: PodSettings
Returns Promise<void>

handleSafe

handleSafe(input: { identifier: ResourceIdentifier; settings: PodSettings }): Promise<void>

Inherited from VariableHandler.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:35
Helper function that first runs the canHandle function followed by the handle function. Throws the error of the canHandle function if the data can't be handled, or returns the result of the handle function otherwise.

Parameters
- input: { identifier: ResourceIdentifier; settings: PodSettings }
  
  Input data that will be handled if it can be handled.
  - identifier: ResourceIdentifier
  - settings: PodSettings
Returns Promise<void>

A promise resolving if the input can be handled, rejecting with an Error if not. Return value depends on the given type.