Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomParametersList<ParameterTypeLiteral>

A list that can be added to a component.

For use in ParameterizedComponent

{@label STATIC_2.1}

Type Parameters

Hierarchy

  • CustomParametersList

Implements

  • Generable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

parameters

parameters: CustomParameter<ParameterTypeLiteral>[]

Accessors

generableType

Methods

[iterator]

define

  • define(name: string, type: ParameterTypeLiteral, defaultValue?: unknown, description?: string, enumValues?: string[]): CustomParameter<ParameterTypeLiteral>

  • Define a parameter to be available to the workflow job. Useful for static configurations.

    Parameters

    • name: string

      name of the parameter

    • type: ParameterTypeLiteral

      the literal type of the parameter

    • Optional defaultValue: unknown

      optional default value of parameter. If this is not provided, the parameter will be required.

    • Optional description: string

      optional description of parameter

    • Optional enumValues: string[]

      list of selectable enum values. Only applicable for enum type parameters.

    Returns CustomParameter<ParameterTypeLiteral>

    this for chaining

generate

Generated using TypeDoc