appconfig

Documentation

Index

• Constants
• Variables
• func FxEmbeddedApplicationAdHoc(fs embed.FS, searchPaths ...string) fx.Option
• func FxEmbeddedBootstrapAdHoc(fs embed.FS, searchPaths ...string) fx.Option
• func FxEmbeddedDefaults(fs embed.FS, searchPaths ...string) fx.Option
• func FxProvideApplicationAdHoc(providers ...interface{}) fx.Option
• func FxProvideBootstrapAdHoc(providers ...interface{}) fx.Option
• func FxProvideDefaults(providers ...interface{}) fx.Option
• func Use()

Constants

const (
	FxGroupBootstrap   = "bootstrap-config"
	FxGroupApplication = "application-config"
	FxGroupDefaults    = "default-config"
)

const (
	PrecedenceExternalAppContext
	PrecedenceExternalDefaultContext
	PrecedenceApplicationAdHoc
	PrecedenceBootstrapAdHoc
	PrecedenceCommandline
	PrecedenceOSEnv
	PrecedenceApplicationLocalFile
	PrecedenceBootstrapLocalFile
	PrecedenceDefault
)

Variables

var Module = &bootstrap.Module{
	Name:       "bootstrap endpoint",
	Precedence: bootstrap.AppConfigPrecedence,
	PriorityOptions: []fx.Option{
		FxEmbeddedDefaults(defaultConfigFS),
		fx.Provide(

			newCommandProviderGroup,
			newOsEnvProviderGroup,
			newBootstrapFileProviderGroup,
			newDefaultProviderGroup,
			newBootstrapAdHocProviderGroup,
			newBootstrapConfig,

			newApplicationFileProviderGroup,
			newApplicationAdHocProviderGroup,

			newApplicationConfig,
			newGlobalProperties,
		),
	},
}

Functions

func FxEmbeddedApplicationAdHoc

func FxEmbeddedApplicationAdHoc(fs embed.FS, searchPaths ...string) fx.Option

FxEmbeddedApplicationAdHoc returns a specialized fx.Option that take a given embed.FS and load *.yml as application properties

func FxEmbeddedBootstrapAdHoc

func FxEmbeddedBootstrapAdHoc(fs embed.FS, searchPaths ...string) fx.Option

FxEmbeddedBootstrapAdHoc returns a specialized fx.Option that take a given embed.FS and load *.yml as bootstrap properties

func FxEmbeddedDefaults

func FxEmbeddedDefaults(fs embed.FS, searchPaths ...string) fx.Option

FxEmbeddedDefaults returns a specialized fx.Option that take a given embed.FS and load *.yml as default properties

func FxProvideApplicationAdHoc

func FxProvideApplicationAdHoc(providers ...interface{}) fx.Option

FxProvideApplicationAdHoc wraps given interface{} as a fx.Provide of appconfig.Provider with order of overriding application properties Supported interface are

• appconfig.Provider
• a function that returns/create appconfig.Provider

func FxProvideBootstrapAdHoc

func FxProvideBootstrapAdHoc(providers ...interface{}) fx.Option

FxProvideBootstrapAdHoc wraps given interface{} as a fx.Provide of appconfig.Provider with order of overriding bootstrap properties Supported interface are

• appconfig.Provider
• a function that returns/create appconfig.Provider

func FxProvideDefaults

func FxProvideDefaults(providers ...interface{}) fx.Option

FxProvideDefaults wraps given interface{} as a fx.Provide of appconfig.Provider with order of default properties Supported interface are

• appconfig.Provider
• a function that returns/create appconfig.Provider

func Use

func Use()

Use Entrypoint of appconfig package