Class WaitStep

Implements

StepBuilder
ConditionBuilder
DependenciesBuilder
KeyBuilder

Index

Constructors

Methods

addDependency allowDependencyFailure build condition continueOnFailure dependOn getCondition getDependencies getKey key setAllowDependencyFailure setCondition setContinueOnFailure setKey

Constructors

constructor

new WaitStep(): WaitStep
Returns WaitStep

Methods

addDependency

addDependency(
dependency: string | { allow_failure?: boolean; step?: string },
): this
Parameters
- dependency: string | { allow_failure?: boolean; step?: string }
Returns this
Implementation of DependenciesBuilder.addDependency
- Defined in builders/WaitStep.ts:54

allowDependencyFailure

allowDependencyFailure(allow: boolean): this
Parameters
- allow: boolean
Returns this
Deprecated
Use .setAllowDependencyFailure() instead
Implementation of DependenciesBuilder.allowDependencyFailure
- Defined in builders/WaitStep.ts:62

build

build(): WaitStepSchema | Promise<WaitStepSchema>
Returns WaitStepSchema | Promise<WaitStepSchema>
Implementation of StepBuilder.build
- Defined in builders/WaitStep.ts:88

condition

condition(condition: string): this
Parameters
- condition: string
Returns this
Deprecated
Use .setCondition() instead
Implementation of ConditionBuilder.condition
- Defined in builders/WaitStep.ts:34

continueOnFailure

continueOnFailure(continueOnFailure: boolean): this
Parameters
- continueOnFailure: boolean
Returns this
Deprecated
Use .setContinueOnFailure() instead
- Defined in builders/WaitStep.ts:18

dependOn

dependOn(dependency: string | { allow_failure?: boolean; step?: string }): this
Parameters
- dependency: string | { allow_failure?: boolean; step?: string }
Returns this
Deprecated
Use .addDependency() instead
Implementation of DependenciesBuilder.dependOn
- Defined in builders/WaitStep.ts:50

getCondition

getCondition(): string | undefined
Returns string | undefined
Implementation of ConditionBuilder.getCondition
- Defined in builders/WaitStep.ts:27

getDependencies

getDependencies(): readonly (
string
| { allow_failure?: boolean; step?: string }
)[]
Returns readonly (string | { allow_failure?: boolean; step?: string })[]
Implementation of DependenciesBuilder.getDependencies
- Defined in builders/WaitStep.ts:43

getKey

getKey(): string | undefined
Returns string | undefined
Implementation of KeyBuilder.getKey
- Defined in builders/WaitStep.ts:71

key

key(key: string): this
Parameters
- key: string
Returns this
Deprecated
Use .setKey() instead
Implementation of KeyBuilder.key
- Defined in builders/WaitStep.ts:78

setAllowDependencyFailure

setAllowDependencyFailure(allow: boolean): this
Parameters
- allow: boolean
Returns this
Implementation of DependenciesBuilder.setAllowDependencyFailure
- Defined in builders/WaitStep.ts:66

setCondition

setCondition(condition: string): this
Parameters
- condition: string
Returns this
Implementation of ConditionBuilder.setCondition
- Defined in builders/WaitStep.ts:38

setContinueOnFailure

setContinueOnFailure(continueOnFailure: boolean): this
Parameters
- continueOnFailure: boolean
Returns this
- Defined in builders/WaitStep.ts:22

setKey

setKey(key: string): this
Parameters
- key: string
Returns this
Implementation of KeyBuilder.setKey
- Defined in builders/WaitStep.ts:83