stdenvcfg

Documentation

Overview

Package stdenvcfg provides environment configuration as an fx dependency.

Index

• func Provide[T any](prefix ...string) fx.Option
• func ProvideExplicitEnvironment(vars map[string]string) fx.Option
• func ProvideNamed[T any](name string, prefix ...string) fx.Option
• func ProvideOSEnvironment() fx.Option
• type Environment
• type HexBytes
  • func (p *HexBytes) UnmarshalText(text []byte) error

Functions

func Provide

func Provide[T any](prefix ...string) fx.Option

Provide configuration T as an fx dependency that parses the environment with an optional prefix.

func ProvideExplicitEnvironment

func ProvideExplicitEnvironment(vars map[string]string) fx.Option

ProvideExplicitEnvironment provides env options with environment options pre-set. Useful for testing.

func ProvideNamed

func ProvideNamed[T any](name string, prefix ...string) fx.Option

ProvideNamed configuration T as an fx dependency that parses the environment with an optional prefix.

func ProvideOSEnvironment

func ProvideOSEnvironment() fx.Option

ProvideOSEnvironment provides an Environment from the os.Environ.

Types

type Environment

type Environment map[string]string

Environment allows providing environment variables pre-set. Useful for testing.

type HexBytes

type HexBytes []byte

HexBytes can be used for configuration to read binary encoded values from the environment variables.

func (*HexBytes) UnmarshalText

func (p *HexBytes) UnmarshalText(text []byte) error