Class Condition

Represent a condition

Hierarchy

Condition

Index

Constructors

Properties

Methods

conditionToString conditionTypeToString execute executeIf executeUnless render setType

Constructors

constructor

new Condition(type: conditionType, condition?: conditionFormat): Condition
Parameters
- type: conditionType
  
  The type of the condition
- Optional condition: conditionFormat
  
  The confition itself
Returns Condition
- Defined in src/src/tools/condition.ts:67

Properties

condition

condition: undefined | conditionFormat

type

type: conditionType

Methods

`Private` conditionToString

conditionToString(condition: conditionFormat, type: conditionType): string
Parameters
- condition: conditionFormat
- type: conditionType
Returns string
- Defined in src/src/tools/condition.ts:86

`Private` conditionTypeToString

conditionTypeToString(type: conditionType): string
Parameters
- type: conditionType
Returns string
- Defined in src/src/tools/condition.ts:81

execute

execute(...commands: Commands): Commands
Execute commands only if the condition passed
Parameters
- Rest ...commands: Commands
  
  The commands to execute
Returns Commands
- Defined in src/src/tools/condition.ts:126

executeIf

executeIf(...commands: Commands): Commands
Execute commands only if the condition passed (has an if condition)
Parameters
- Rest ...commands: Commands
  
  The commands to execute
Returns Commands
- Defined in src/src/tools/condition.ts:135

executeUnless

executeUnless(...commands: Commands): Commands
Execute commands only if the condition passed (has an if not condition)
Parameters
- Rest ...commands: Commands
  
  The commands to execute
Returns Commands
- Defined in src/src/tools/condition.ts:143

render

render(type?: conditionType): string
Parameters
- Optional type: conditionType
Returns string
- Defined in src/src/tools/condition.ts:148

setType

setType(type: conditionType): Condition
Set the new condition's type
Parameters
- type: conditionType
  
  The new condition's type
Returns Condition
- Defined in src/src/tools/condition.ts:76

Generated using TypeDoc