core

Documentation

Index

• Variables
• type Command
• type CommandRunner
• type Database
  • func NewDatabase(env *Env, logger *Logger) *Database
• 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 GormLogger
  • func (l *GormLogger) Error(ctx context.Context, str string, args ...interface{})
  • func (l *GormLogger) Info(ctx context.Context, str string, args ...interface{})
  • func (l *GormLogger) LogMode(level gormlogger.LogLevel) gormlogger.Interface
  • func (l *GormLogger) Trace(ctx context.Context, begin time.Time, fc func() (string, int64), err error)
  • func (l *GormLogger) Warn(ctx context.Context, str string, args ...interface{})
• type ImageKit
  • func NewImageKit(env *Env) *ImageKit
• type Logger
  • func GetLogger() *Logger
  • func (l *Logger) GetFxLogger() fxevent.Logger
  • func (l *Logger) GetGinLogger() *GinLogger
  • func (l *Logger) GetGormLogger() *GormLogger
• type RequestHandler
  • func NewRequestHandler(logger *Logger) *RequestHandler
• type Validator
  • func NewValidator() *Validator

Variables

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

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 {
	*gorm.DB
}

Database modal

func NewDatabase

func NewDatabase(env *Env, logger *Logger) *Database

NewDatabase creates a new database instance

type Env

type Env struct {
	ServerPort                 string        `mapstructure:"SERVER_PORT"`
	Environment                string        `mapstructure:"ENV"`
	LogOutput                  string        `mapstructure:"LOG_OUTPUT"`
	LogLevel                   string        `mapstructure:"LOG_LEVEL"`
	DBUsername                 string        `mapstructure:"DB_USER"`
	DBPassword                 string        `mapstructure:"DB_PASS"`
	DBHost                     string        `mapstructure:"DB_HOST"`
	DBPort                     string        `mapstructure:"DB_PORT"`
	DBName                     string        `mapstructure:"DB_NAME"`
	SmtpUser                   string        `mapstructure:"SMTP_USER"`
	SmtpPassword               string        `mapstructure:"SMTP_PASS"`
	SmtpHost                   string        `mapstructure:"SMTP_HOST"`
	IkPublicKey                string        `mapstructure:"IK_PUBLIC_KEY"`
	IkPrivateKey               string        `mapstructure:"IK_PRIVATE_KEY"`
	IkUrlEndpoint              string        `mapstructure:"IK_URL_ENDPOINT"`
	JWTSecret                  string        `mapstructure:"JWT_SECRET"`
	AccessTokenExpiresIn       time.Duration `mapstructure:"ACCESS_TOKEN_EXPIRED_IN"`
	RefreshTokenExpiresIn      time.Duration `mapstructure:"REFRESH_TOKEN_EXPIRED_IN"`
	EmailVerificationExpiresIn time.Duration `mapstructure:"EMAIL_VERIFICATION_EXPIRED_IN"`
}

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 GormLogger

type GormLogger struct {
	*Logger
	gormlogger.Config
}

func (*GormLogger) Error

func (l *GormLogger) Error(ctx context.Context, str string, args ...interface{})

Error prints error messages

func (*GormLogger) Info

func (l *GormLogger) Info(ctx context.Context, str string, args ...interface{})

Info prints info

func (*GormLogger) LogMode

func (l *GormLogger) LogMode(level gormlogger.LogLevel) gormlogger.Interface

LogMode set log mode

func (*GormLogger) Trace

func (l *GormLogger) Trace(ctx context.Context, begin time.Time, fc func() (string, int64), err error)

Trace prints trace messages

func (*GormLogger) Warn

func (l *GormLogger) Warn(ctx context.Context, str string, args ...interface{})

Warn prints warn messages

type ImageKit

type ImageKit struct {
	*imagekit.ImageKit
}

func NewImageKit

func NewImageKit(env *Env) *ImageKit

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

func (*Logger) GetGormLogger

func (l *Logger) GetGormLogger() *GormLogger

GetGormLogger gets the gorm framework logger

type RequestHandler

type RequestHandler struct {
	Gin *gin.Engine
}

RequestHandler function

func NewRequestHandler

func NewRequestHandler(logger *Logger) *RequestHandler

NewRequestHandler creates a new request handler

type Validator

type Validator struct {
	*validator.Validate
}

func NewValidator

func NewValidator() *Validator