envconfig

Documentation

Overview

Package envconfig provides a convenient way to load config from environment variables into a struct using https://github.com/kelseyhightower/envconfig.

Example

Index

• func Close() error
• func Read(ptr interface{}, opts ...config.ReadOption) error
• type Config
  • func (env *Config) Close() error
  • func (env *Config) Read(ptr interface{}, opts ...config.ReadOption) error

Examples

• Package
• Read (WithOptions)

Functions

func Close

func Close() error

Close close the default config reader.

func Read

func Read(ptr interface{}, opts ...config.ReadOption) error

Read read configuration from environment to the target ptr.

Example (WithOptions)

Types

type Config

type Config struct {
}

Config implements config.Reader.

func (*Config) Close

func (env *Config) Close() error

Close implements config.Reader interface.

func (*Config) Read

func (env *Config) Read(ptr interface{}, opts ...config.ReadOption) error

Read implements config.Reader interface.