lib

Documentation

Index

• Variables
• type Command
• type CommandRunner
• type Database
  • func NewDatabase(env Env, logger Logger) Database
  • func (db *Database) Collection(name string) *mongo.Collection
• type Env
  • func NewEnv() Env
• type FxLogger
  • func (l *FxLogger) LogEvent(event fxevent.Event)
  • func (l FxLogger) Printf(str string, args ...interface{})
• type GinLogger
  • func (l GinLogger) Write(p []byte) (n int, err error)
• type Logger
  • func GetLogger() Logger
  • func (l *Logger) GetFxLogger() fxevent.Logger
  • func (l Logger) GetGinLogger() GinLogger
• type RequestHandler
  • func NewRequestHandler(logger Logger) RequestHandler

Variables

var Module = fx.Options(
	fx.Provide(NewRequestHandler),
	fx.Provide(NewEnv),
	fx.Provide(GetLogger),
	fx.Provide(NewDatabase),
)

Module exports dependency

Types

type Command

type Command interface {
	// Short returns string about short description of the command
	// the string is shown in help screen of cobra command
	Short() string

	// Setup is used to setup flags or pre-run steps for the command.
	//
	// For example,
	//  cmd.Flags().IntVarP(&r.num, "num", "n", 5, "description")
	//
	Setup(cmd *cobra.Command)

	// Run runs the command runner
	// run returns command runner which is a function with dependency
	// injected arguments.
	//
	// For example,
	//  Command{
	//   Run: func(l lib.Logger) {
	// 	   l.Info("i am working")
	// 	 },
	//  }
	//
	Run() CommandRunner
}

Command interface is used to implement sub-commands in the system.

type CommandRunner

type CommandRunner interface{}

type Database

type Database struct {
	Client   *mongo.Client
	Database *mongo.Database
}

Database modal

func NewDatabase

func NewDatabase(env Env, logger Logger) Database

NewDatabase creates a new database instance

func (*Database) Collection

func (db *Database) Collection(name string) *mongo.Collection

type Env

type Env struct {
	ServerPort  string `mapstructure:"SERVER_PORT"`
	Environment string `mapstructure:"ENV"`
	LogOutput   string `mapstructure:"LOG_OUTPUT"`
	MongoDBURI  string `mapstructure:"MONGODB_URI"`
	MongoDBName string `mapstructure:"MONGODB_NAME"`
}

Env has environment stored

func NewEnv

func NewEnv() Env

NewEnv creates a new environment

type FxLogger

type FxLogger struct {
	*Logger
}

func (*FxLogger) LogEvent

func (l *FxLogger) LogEvent(event fxevent.Event)

LogEvent log event for fx logger

func (FxLogger) Printf

func (l FxLogger) Printf(str string, args ...interface{})

Printf prits go-fx logs

type GinLogger

type GinLogger struct {
	*Logger
}

func (GinLogger) Write

func (l GinLogger) Write(p []byte) (n int, err error)

Write interface implementation for gin-framework

type Logger

type Logger struct {
	*zap.SugaredLogger
}

Logger structure

func GetLogger

func GetLogger() Logger

GetLogger get the logger

func (*Logger) GetFxLogger

func (l *Logger) GetFxLogger() fxevent.Logger

GetFxLogger gets logger for go-fx

func (Logger) GetGinLogger

func (l Logger) GetGinLogger() GinLogger

GetGinLogger get the gin logger

type RequestHandler

type RequestHandler struct {
	Gin *gin.Engine
}

RequestHandler function

func NewRequestHandler

func NewRequestHandler(logger Logger) RequestHandler

NewRequestHandler creates a new request handler