Class BlockStep

Implements

StepBuilder
LabelBuilder
KeyBuilder
BranchFilterBuilder
DependenciesBuilder
ConditionBuilder
PromptBuilder

Constructors

constructor

new BlockStep(): BlockStep
Returns BlockStep

Methods

addBranch

addBranch(branch: string): this
Parameters
- branch: string
Returns this
Implementation of BranchFilterBuilder.addBranch
- Defined in builders/BlockStep.ts:86

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/BlockStep.ts:102

addField

addField(
    field:
        | {
            default?: string;
            hint?: string;
            key: string;
            required?: boolean;
            text?: string;
        }
        | {
            default?: string
            | string[];
            hint?: string;
            key: string;
            multiple?: boolean;
            options: {
                hint?: string;
                label: string;
                required?: boolean;
                value: string;
            }[];
            required?: boolean;
            select?: string;
        },
): this
Parameters
- field:
      | {
          default?: string;
          hint?: string;
          key: string;
          required?: boolean;
          text?: string;
      }
      | {
          default?: string
          | string[];
          hint?: string;
          key: string;
          multiple?: boolean;
          options: {
              hint?: string;
              label: string;
              required?: boolean;
              value: string;
          }[];
          required?: boolean;
          select?: string;
      }
  - {
        default?: string;
        hint?: string;
        key: string;
        required?: boolean;
        text?: string;
    }
    Optionaldefault?: string
    The value that is pre-filled in the text field
    
    Optionalhint?: string
    The explanatory text that is shown after the label
    
    key: string
    The meta-data key that stores the field's input
    
    Optionalrequired?: boolean
    Whether the field is required for form submission
    
    Optionaltext?: string
    The text input name
  - {
        default?: string | string[];
        hint?: string;
        key: string;
        multiple?: boolean;
        options: {
            hint?: string;
            label: string;
            required?: boolean;
            value: string;
        }[];
        required?: boolean;
        select?: string;
    }
    Optionaldefault?: string | string[]
    The value of the option(s) that will be pre-selected in the dropdown
    
    Optionalhint?: string
    The explanatory text that is shown after the label
    
    key: string
    The meta-data key that stores the field's input
    
    Optionalmultiple?: boolean
    Whether more than one option may be selected
    
    options: { hint?: string; label: string; required?: boolean; value: string }[]
    Optionalrequired?: boolean
    Whether the field is required for form submission
    
    Optionalselect?: string
    The text input name
Returns this
Implementation of PromptBuilder.addField
- Defined in builders/BlockStep.ts:140

allowDependencyFailure

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

branch

branch(branch: string): this
Parameters
- branch: string
Returns this
Deprecated
Use .addBranch() instead
Implementation of BranchFilterBuilder.branch
- Defined in builders/BlockStep.ts:81

build

build(): BlockStepSchema | Promise<BlockStepSchema>
Returns BlockStepSchema | Promise<BlockStepSchema>
Implementation of StepBuilder.build
- Defined in builders/BlockStep.ts:161

condition

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

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/BlockStep.ts:98

field

field(
    field:
        | {
            default?: string;
            hint?: string;
            key: string;
            required?: boolean;
            text?: string;
        }
        | {
            default?: string
            | string[];
            hint?: string;
            key: string;
            multiple?: boolean;
            options: {
                hint?: string;
                label: string;
                required?: boolean;
                value: string;
            }[];
            required?: boolean;
            select?: string;
        },
): this
Parameters
- field:
      | {
          default?: string;
          hint?: string;
          key: string;
          required?: boolean;
          text?: string;
      }
      | {
          default?: string
          | string[];
          hint?: string;
          key: string;
          multiple?: boolean;
          options: {
              hint?: string;
              label: string;
              required?: boolean;
              value: string;
          }[];
          required?: boolean;
          select?: string;
      }
  - {
        default?: string;
        hint?: string;
        key: string;
        required?: boolean;
        text?: string;
    }
    Optionaldefault?: string
    The value that is pre-filled in the text field
    
    Optionalhint?: string
    The explanatory text that is shown after the label
    
    key: string
    The meta-data key that stores the field's input
    
    Optionalrequired?: boolean
    Whether the field is required for form submission
    
    Optionaltext?: string
    The text input name
  - {
        default?: string | string[];
        hint?: string;
        key: string;
        multiple?: boolean;
        options: {
            hint?: string;
            label: string;
            required?: boolean;
            value: string;
        }[];
        required?: boolean;
        select?: string;
    }
    Optionaldefault?: string | string[]
    The value of the option(s) that will be pre-selected in the dropdown
    
    Optionalhint?: string
    The explanatory text that is shown after the label
    
    key: string
    The meta-data key that stores the field's input
    
    Optionalmultiple?: boolean
    Whether more than one option may be selected
    
    options: { hint?: string; label: string; required?: boolean; value: string }[]
    Optionalrequired?: boolean
    Whether the field is required for form submission
    
    Optionalselect?: string
    The text input name
Returns this
Deprecated
Use .addField() instead
Implementation of PromptBuilder.field
- Defined in builders/BlockStep.ts:135

getBranches

getBranches(): readonly string[]
Returns readonly string[]
Implementation of BranchFilterBuilder.getBranches
- Defined in builders/BlockStep.ts:74

getCondition

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

getDependencies

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

getKey

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

getLabel

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

key

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

label

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

prompt

prompt(prompt: string): this
Parameters
- prompt: string
Returns this
Deprecated
Use .setPrompt() instead
Implementation of PromptBuilder.prompt
- Defined in builders/BlockStep.ts:122

setAllowDependencyFailure

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

setCondition

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

setKey

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

setLabel

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

setPrompt

setPrompt(prompt: string): this
Parameters
- prompt: string
Returns this
Implementation of PromptBuilder.setPrompt
- Defined in builders/BlockStep.ts:127

setState

setState(state: "passed" | "failed" | "running"): this
Parameters
- state: "passed" | "failed" | "running"
Returns this
- Defined in builders/BlockStep.ts:52

state

state(state: "passed" | "failed" | "running"): this
Parameters
- state: "passed" | "failed" | "running"
Returns this
Deprecated
Use .setState() instead
- Defined in builders/BlockStep.ts:48

Class BlockStep

Implements

Index

Constructors

Methods

Constructors

constructor

Returns BlockStep

Methods

addBranch

Parameters

Returns this

addDependency

Parameters

Returns this

addField

Parameters

Optionaldefault?: string

Optionalhint?: string

key: string

Optionalrequired?: boolean

Optionaltext?: string

Optionaldefault?: string | string[]

Optionalhint?: string

key: string

Optionalmultiple?: boolean

options: { hint?: string; label: string; required?: boolean; value: string }[]

Optionalrequired?: boolean

Optionalselect?: string

Returns this

allowDependencyFailure

Parameters

Returns this

Deprecated

branch

Parameters

Returns this

Deprecated

build

Returns BlockStepSchema | Promise<BlockStepSchema>

condition

Parameters

Returns this

Deprecated

dependOn

Parameters

Returns this

Deprecated

field

Parameters

Optionaldefault?: string

Optionalhint?: string

key: string

Optionalrequired?: boolean

Optionaltext?: string

Optionaldefault?: string | string[]

Optionalhint?: string

key: string

Optionalmultiple?: boolean

options: { hint?: string; label: string; required?: boolean; value: string }[]

Optionalrequired?: boolean

Optionalselect?: string

Returns this

Deprecated

getBranches

Returns readonly string[]

getCondition

Returns string | undefined

getDependencies

Returns readonly (string | { allow_failure?: boolean; step?: string })[]

getKey

Returns string | undefined

getLabel

Returns string | undefined

key

Parameters

Returns this

Deprecated

label

Parameters

`Optional`default?: string

`Optional`hint?: string

`Optional`required?: boolean

`Optional`text?: string

`Optional`default?: string | string[]

`Optional`hint?: string

`Optional`multiple?: boolean

`Optional`required?: boolean

`Optional`select?: string

`Optional`default?: string

`Optional`hint?: string

`Optional`required?: boolean

`Optional`text?: string

`Optional`default?: string | string[]

`Optional`hint?: string

`Optional`multiple?: boolean

`Optional`required?: boolean

`Optional`select?: string