Class GroupStep

Implements

StepBuilder
KeyBuilder
LabelBuilder
DependenciesBuilder
SkipBuilder
StepsBuilder

Index

Constructors

constructor

new GroupStep(): GroupStep
Returns GroupStep

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/GroupStep.ts:112

addStep

addStep(step: StepSchema | StepBuilder): this
Parameters
- step: StepSchema | StepBuilder
Returns this
Implementation of StepsBuilder.addStep
- Defined in builders/GroupStep.ts:54

addSteps

addSteps(steps: Iterable<StepSchema | StepBuilder>): this
Parameters
- steps: Iterable<StepSchema | StepBuilder>
Returns this
Implementation of StepsBuilder.addSteps
- Defined in builders/GroupStep.ts:67

allowDependencyFailure

allowDependencyFailure(allow: boolean): this
Parameters
- allow: boolean
Returns this
Deprecated
Use .setKey() instead
Implementation of DependenciesBuilder.allowDependencyFailure
- Defined in builders/GroupStep.ts:120

build

build(): Promise<GroupStepSchema>
Returns Promise<GroupStepSchema>
Implementation of StepBuilder.build
- Defined in builders/GroupStep.ts:129

dependOn

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

getDependencies

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

getKey

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

getLabel

getLabel(): string | undefined
Returns string | undefined
Implementation of LabelBuilder.getLabel
- Defined in builders/GroupStep.ts:25

getSteps

getSteps(): readonly (StepSchema | StepBuilder)[]
Returns readonly (StepSchema | StepBuilder)[]
Implementation of StepsBuilder.getSteps
- Defined in builders/GroupStep.ts:42

key

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

label

label(label: string): this
Parameters
- label: string
Returns this
Deprecated
Use .setLabel() instead
Implementation of LabelBuilder.label
- Defined in builders/GroupStep.ts:32

setAllowDependencyFailure

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

setKey

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

setLabel

setLabel(label: string): this
Parameters
- label: string
Returns this
Implementation of LabelBuilder.setLabel
- Defined in builders/GroupStep.ts:37

setSkip

setSkip(skip: string | boolean): this
Parameters
- skip: string | boolean
Returns this
Implementation of SkipBuilder.setSkip
- Defined in builders/GroupStep.ts:96

skip

skip(skip: string | boolean): this
Parameters
- skip: string | boolean
Returns this
Deprecated
Use .setSkip() instead
Implementation of SkipBuilder.skip
- Defined in builders/GroupStep.ts:92

step

step(step: StepSchema | StepBuilder): this
Parameters
- step: StepSchema | StepBuilder
Returns this
Deprecated
Use .addStep() instead
Implementation of StepsBuilder.step
- Defined in builders/GroupStep.ts:49

steps

steps(steps: Iterable<StepSchema | StepBuilder>): this
Parameters
- steps: Iterable<StepSchema | StepBuilder>
Returns this
Deprecated
Use .addSteps() instead
Implementation of StepsBuilder.steps
- Defined in builders/GroupStep.ts:62