Documentation
¶
Index ¶
Constants ¶
View Source
const ( TypeString = parameters.ParameterTypeString TypeSecret = parameters.ParameterTypeSecret TypeStringFromFile = parameters.ParameterTypeStringFromFile TypeStringFromFiles = parameters.ParameterTypeStringFromFiles TypeFile = parameters.ParameterTypeFile TypeFileList = parameters.ParameterTypeFileList TypeObjectListFromFile = parameters.ParameterTypeObjectListFromFile TypeObjectListFromFiles = parameters.ParameterTypeObjectListFromFiles TypeObjectFromFile = parameters.ParameterTypeObjectFromFile TypeStringListFromFile = parameters.ParameterTypeStringListFromFile TypeStringListFromFiles = parameters.ParameterTypeStringListFromFiles TypeKeyValue = parameters.ParameterTypeKeyValue TypeInteger = parameters.ParameterTypeInteger TypeFloat = parameters.ParameterTypeFloat TypeBool = parameters.ParameterTypeBool TypeDate = parameters.ParameterTypeDate TypeStringList = parameters.ParameterTypeStringList TypeIntegerList = parameters.ParameterTypeIntegerList TypeFloatList = parameters.ParameterTypeFloatList TypeChoice = parameters.ParameterTypeChoice TypeChoiceList = parameters.ParameterTypeChoiceList )
Re-export common field types
Variables ¶
View Source
var ( WithHelp = parameters.WithHelp WithShortFlag = parameters.WithShortFlag WithDefault = parameters.WithDefault WithChoices = parameters.WithChoices WithRequired = parameters.WithRequired WithIsArgument = parameters.WithIsArgument )
Re-export common field definition options
Functions ¶
This section is empty.
Types ¶
type Definition ¶
type Definition = parameters.ParameterDefinition
Definition is a type alias for parameters.ParameterDefinition. A Definition specifies a single field in a schema section (name, type, default, help, etc.).
type Definitions ¶
type Definitions = parameters.ParameterDefinitions
Definitions is a type alias for parameters.ParameterDefinitions. Definitions is an ordered collection of field definitions.
func NewDefinitions ¶
func NewDefinitions(options ...parameters.ParameterDefinitionsOption) *Definitions
NewDefinitions creates a new collection of field definitions. It wraps parameters.NewParameterDefinitions.
type Option ¶
type Option = parameters.ParameterDefinitionOption
Option is a type alias for parameters.ParameterDefinitionOption. Option configures a Definition during construction.
type Type ¶
type Type = parameters.ParameterType
Type is a type alias for parameters.ParameterType. Type represents the type of a field (string, int, bool, etc.).
Source Files
Click to show internal directories.
Click to hide internal directories.