pkg

Documentation

Index

• Variables
• func AnnotateError(original, markAs error, wrapWith string) error
• func AnnotateErrorWithDetail(original, markAs error, wrapWith, humanMessage string) error
• type Config
  • func NewConfig() *Config
• type Logger
  • func NewEmptyLogger() *Logger
  • func NewLogger() *Logger
  • func NewPrettyLogger() *Logger

Variables

var (
	ErrBadInput      = errors.New("provided input is invalid")
	ErrNotFound      = errors.New("resource not found")
	ErrDuplicate     = errors.New("resource is not unique")
	ErrDatabaseError = errors.New("database error")
)

var Version string

Version can now be provided on build using -ldflags "-X github.com/dmitry-kostin/go-rest/src/pkg.Version=1.0.0"

Functions

func AnnotateError

func AnnotateError(original, markAs error, wrapWith string) error

func AnnotateErrorWithDetail

func AnnotateErrorWithDetail(original, markAs error, wrapWith, humanMessage string) error

Types

type Config

type Config struct {
	AppHostName      string   `env:"APP_HOST_NAME" envDefault:"127.0.0.1"`
	AppEnv           string   `env:"APP_ENV" envDefault:"LOCAL"`
	AppPort          string   `env:"APP_PORT" envDefault:"3001"`
	DatabaseName     string   `env:"DB_APP_NAME"`
	DatabaseUser     string   `env:"DB_APP_USER"`
	DatabasePassword string   `env:"DB_APP_PASSWORD"`
	DatabaseHostname string   `env:"DB_APP_HOSTNAME" envDefault:"127.0.0.1"`
	AppAPIKeys       []string `env:"APP_API_KEYS" envDefault:""`
	Version          string   `envDefault:"-"`
}

func NewConfig

func NewConfig() *Config

type Logger

type Logger struct {
	zerolog.Logger
}

func NewEmptyLogger

func NewEmptyLogger() *Logger

func NewLogger

func NewLogger() *Logger

func NewPrettyLogger

func NewPrettyLogger() *Logger