application

Documentation

Index

• Variables
• func DB() *gorm.DB
• func InitLogger(level string) *logrus.Logger
• func LoadDB(driver, url string) (*gorm.DB, error)
• func LoadEnv() error
• func Logger() *logrus.Logger
• func Storage() cache.Storager
• type Application
  • func Get() *Application
  • func Init() *Application
  • func (a *Application) AddShutdown(s Shutdown)
  • func (a *Application) CloseConnections()
  • func (a *Application) DB() *gorm.DB
  • func (a *Application) Deps() *Dependencies
  • func (a *Application) EnvMode() EnvironmentMode
  • func (a *Application) Logger() *logrus.Logger
  • func (a *Application) SetDB(db *gorm.DB)
  • func (a *Application) SetLogger(logger *logrus.Logger)
  • func (a *Application) Shutdown(ctx context.Context)
• type Dependencies
  • func Deps() *Dependencies
• type EnvironmentMode
  • func EnvMode() EnvironmentMode
• type Shutdown

Variables

var (
	ErrInvalidEnvMode = errors.New("invalid environment mode")
)

Application errors

Functions

func DB

func DB() *gorm.DB

func InitLogger

func InitLogger(level string) *logrus.Logger

Logrus logger initialization

func LoadDB

func LoadDB(driver, url string) (*gorm.DB, error)

Database initialization

func LoadEnv

func LoadEnv() error

Load .env file from root directory

func Logger

func Logger() *logrus.Logger

func Storage

func Storage() cache.Storager

Types

type Application

type Application struct {
	Dependencies *Dependencies
	// contains filtered or unexported fields
}

func Get

func Get() *Application

func Init

func Init() *Application

Initializing a Application

func (*Application) AddShutdown

func (a *Application) AddShutdown(s Shutdown)

func (*Application) CloseConnections

func (a *Application) CloseConnections()

func (*Application) DB

func (a *Application) DB() *gorm.DB

func (*Application) Deps

func (a *Application) Deps() *Dependencies

func (*Application) EnvMode

func (a *Application) EnvMode() EnvironmentMode

func (*Application) Logger

func (a *Application) Logger() *logrus.Logger

func (*Application) SetDB

func (a *Application) SetDB(db *gorm.DB)

func (*Application) SetLogger

func (a *Application) SetLogger(logger *logrus.Logger)

func (*Application) Shutdown

func (a *Application) Shutdown(ctx context.Context)

type Dependencies

type Dependencies struct {
	BaseQuery queries.Query
	Storage   cache.Storager
}

func Deps

func Deps() *Dependencies

type EnvironmentMode

type EnvironmentMode string

const (
	Unknown     EnvironmentMode = "unknown"
	Development EnvironmentMode = "dev"
	Production  EnvironmentMode = "prod"
)

func EnvMode

func EnvMode() EnvironmentMode

type Shutdown

type Shutdown func(ctx context.Context) error