config

Documentation

Index

• Constants
• Variables
• func BindParameters(p any, namespace string)
• func Init(container *dig.Container)
• func PrintConfig(ignoreSettingsAtPrint ...[]string)
• type ParametersDefinition

Constants

const (
	CfgDisablePlugins = "node.disablePlugins"
	CfgEnablePlugins  = "node.enablePlugins"
)

The following flags are only for text support.

const PluginName = "Config"

PluginName is the name of the config plugin.

Variables

var Parameters = &ParametersDefinition{}

Parameters contains the configuration parameters of the config plugin.

var (
	// Plugin is the plugin instance of the config plugin.
	Plugin = node.NewPlugin(PluginName, nil, node.Enabled)
)

Functions

func BindParameters

func BindParameters(p any, namespace string)

func Init

func Init(container *dig.Container)

Init triggers the Init event.

func PrintConfig

func PrintConfig(ignoreSettingsAtPrint ...[]string)

PrintConfig prints the config.

Types

type ParametersDefinition

type ParametersDefinition struct {
	// EnablePlugins is the flag to manually enable node plugins.
	EnablePlugins []string `usage:"a list of plugins that shall be enabled"`

	// DisablePlugins is the flag to manually disable node plugins.
	DisablePlugins []string `usage:"a list of plugins that shall be disabled"`
}

ParametersDefinition contains the definition of configuration parameters used by the config plugin.