app

Documentation

Index

• Constants
• type App
  • func (app *App) IsInDemoMode() bool
  • func (app *App) IsInDevMode() bool
  • func (app *App) IsInLocalMode() bool
  • func (app *App) IsInMode(mode string) bool
  • func (app *App) IsInProdMode() bool
  • func (app *App) IsInTestMode() bool
• type DevPanel
• type Flags
  • func (f *Flags) Bool(name string) bool
  • func (f *Flags) String(name string) string
• type FlagsRegistry
  • func (r *FlagsRegistry) Bool(name string, value bool, usage string)
  • func (r *FlagsRegistry) String(name string, value string, usage string)
• type IDevPanelUserEntity
• type IExit
• type IScript
• type Infinity
• type Intermediate
• type Interval
• type IntervalOptional
• type Optional
• type RedisPools

Constants

const ModeDemo = "demo"

const ModeDev = "dev"

const ModeLocal = "local"

const ModeProd = "prod"

const ModeTest = "test"

Types

type App

type App struct {
	Mode           string
	Name           string
	ParallelTestID string
	Secret         string
	Flags          *Flags
	Scripts        []string
	DevPanel       *DevPanel
	RedisPools     *RedisPools
	GlobalContext  context.Context
	CancelContext  context.CancelFunc
}

func (*App) IsInDemoMode

func (app *App) IsInDemoMode() bool

func (*App) IsInDevMode

func (app *App) IsInDevMode() bool

func (*App) IsInLocalMode

func (app *App) IsInLocalMode() bool

func (*App) IsInMode

func (app *App) IsInMode(mode string) bool

func (*App) IsInProdMode

func (app *App) IsInProdMode() bool

func (*App) IsInTestMode

func (app *App) IsInTestMode() bool

type DevPanel

type DevPanel struct {
	UserEntity IDevPanelUserEntity
	Router     func(ginEngine *gin.Engine)
}

type Flags

type Flags struct {
	Registry *FlagsRegistry
}

func (*Flags) Bool

func (f *Flags) Bool(name string) bool

func (*Flags) String

func (f *Flags) String(name string) string

type FlagsRegistry

type FlagsRegistry struct {
	Flags map[string]interface{}
}

func (*FlagsRegistry) Bool

func (r *FlagsRegistry) Bool(name string, value bool, usage string)

func (*FlagsRegistry) String

func (r *FlagsRegistry) String(name string, value string, usage string)

type IDevPanelUserEntity

type IDevPanelUserEntity interface {
	beeorm.Entity
	GetUsername() string
	GetPassword() string
}

type IExit

type IExit interface {
	Valid()
	Error()
	Custom(exitCode int)
}

type IScript

type IScript interface {
	Description() string
	Run(ctx context.Context, exit IExit)
	Unique() bool
}

type Infinity

type Infinity interface {
	Infinity() bool
}

type Intermediate

type Intermediate interface {
	IsIntermediate() bool
}

type Interval

type Interval interface {
	Interval() time.Duration
}

type IntervalOptional

type IntervalOptional interface {
	IntervalActive() bool
}

type Optional

type Optional interface {
	Active() bool
}

type RedisPools

type RedisPools struct {
	Cache      string
	Persistent string
	Stream     string
	Search     string
}