config

Documentation

Overview

Package config package

Index

• type Config
  • func Load(optFns ...func(*LoadOptions) error) (*Config, error)
  • func (c Config) Validate() error
• type LoadOptions
• type LoadOptionsFunc
  • func WithEndpoint(endpoint string) LoadOptionsFunc
  • func WithLogger(v *log.Logger) LoadOptionsFunc
  • func WithTokenProvider(v auth.TokenProvider) LoadOptionsFunc

Types

type Config

type Config struct {
	Logger        *log.Logger
	TokenProvider auth.TokenProvider
	Endpoint      string
}

Config holds a configuration.

func Load

func Load(optFns ...func(*LoadOptions) error) (*Config, error)

Load loads a configuration from a file and/or environment variables.

func (Config) Validate

func (c Config) Validate() error

Validate validates a config.

type LoadOptions

type LoadOptions struct {
	Logger        *log.Logger
	TokenProvider auth.TokenProvider
	Endpoint      string
}

LoadOptions holds the options for loading a configuration.

type LoadOptionsFunc

type LoadOptionsFunc func(*LoadOptions) error

LoadOptionsFunc is a type alias for the type of function that adds a load option.

func WithEndpoint

func WithEndpoint(endpoint string) LoadOptionsFunc

WithEndpoint add/sets the specified endpoint, replacing THARSIS_ENDPOINT

func WithLogger

func WithLogger(v *log.Logger) LoadOptionsFunc

WithLogger adds the specified logger.

func WithTokenProvider

func WithTokenProvider(v auth.TokenProvider) LoadOptionsFunc

WithTokenProvider adds the specified authentication provider.