Interface BuildOptionInputDefinition

Represents an input for a build option.

interface BuildOptionInputDefinition {
    defaultValue?: string;
    groupName?: string;
    help?: { [key: string]: string };
    label?: string;
    name?: string;
    options?: { [key: string]: string };
    required?: boolean;
    type?: BuildOptionInputType;
    visibleRule?: string;
}

Properties

defaultValue? groupName? help? label? name? options? required? type? visibleRule?

Properties

OptionaldefaultValue

defaultValue?: string

The default value.

OptionalgroupName

groupName?: string

The name of the input group that this input belongs to.

Optionalhelp

help?: { [key: string]: string }

Optionallabel

label?: string

The label for the input.

Optionalname

name?: string

The name of the input.

Optionaloptions

options?: { [key: string]: string }

Optionalrequired

required?: boolean

Indicates whether the input is required to have a value.

Optionaltype

type?: BuildOptionInputType

Indicates the type of the input value.

OptionalvisibleRule

visibleRule?: string

The rule that is applied to determine whether the input is visible in the UI.

Settings

Member Visibility

On This Page

Properties