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

Overrides VariableHandler.constructor
- Defined in src/pods/generate/variables/VariableSetter.ts:13
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 can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- input: { identifier: ResourceIdentifier; settings: PodSettings }
  
  Input 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
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- __namedParameters: { settings: PodSettings }
  - settings: PodSettings
Returns Promise<void>
A promise resolving when handling is finished.

handleSafe

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

Inherited from VariableHandler.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle 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.