parameter

package
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 13, 2026 License: BSD-3-Clause Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Parameter

type Parameter[ValueType any] struct {
	// contains filtered or unexported fields
}

func NewParameter

func NewParameter[ValueType any](
	id string,
	flagName string,
	hiddenFlag bool,
	envVarName string,
	descriptionKey messages.MessageKey,
	defaultValue ValueType,
	recordToLog bool,
) *Parameter[ValueType]

func (Parameter[ValueType]) GetActive

func (p Parameter[ValueType]) GetActive() bool

func (Parameter[ValueType]) GetDefaultValue

func (p Parameter[ValueType]) GetDefaultValue() any

func (Parameter[ValueType]) GetDescription

func (p Parameter[ValueType]) GetDescription() string

func (Parameter[ValueType]) GetDescriptionKey

func (p Parameter[ValueType]) GetDescriptionKey() messages.MessageKey

func (Parameter[ValueType]) GetEnvVarName

func (p Parameter[ValueType]) GetEnvVarName() string

func (Parameter[ValueType]) GetFlagName

func (p Parameter[ValueType]) GetFlagName() string

func (Parameter[ValueType]) GetHiddenFlag

func (p Parameter[ValueType]) GetHiddenFlag() bool

func (Parameter[ValueType]) GetID

func (p Parameter[ValueType]) GetID() string

func (Parameter[ValueType]) GetRecordToLog

func (p Parameter[ValueType]) GetRecordToLog() bool

func (*Parameter[ValueType]) SetActive

func (p *Parameter[ValueType]) SetActive(active bool)

func (*Parameter[ValueType]) SetDescription

func (p *Parameter[ValueType]) SetDescription(description string)

type ParameterWithDescriptionFromMessageCatalog

type ParameterWithDescriptionFromMessageCatalog interface {
	entities.Parameter
	SetActive(active bool)
	SetDescription(description string)
	GetDescriptionKey() messages.MessageKey
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL