updateloop

Documentation

Index

• func Module() fx.Option
• type Config
  • func ProvideConfig() (*Config, error)
• type ResVersion
• type Service
  • func NewService(avgS *avg.Service, assetS *asset.Service, appConf *config.Config, conf *Config) *Service
  • func (s *Service) AttemptUpdate(ctx context.Context) error
  • func (s *Service) ResDir(r ResVersion) string
  • func (s *Service) ResVer(ctx context.Context) (ResVersion, ResVersion, error)
  • func (s *Service) StaticDir(r ResVersion) string
  • func (s *Service) VersioningDir(r ResVersion) string

Functions

func Module

func Module() fx.Option

Types

type Config

type Config struct {
	// ForceUpdate indicates whether updateloop should force an update operation (only once).
	// This environment variable is useful in development. Don't use in production unless you find it fits.
	ForceUpdate bool `env:"FORCE_UPDATE" envDefault:"false"`
	// ForceSubmit indicates whether updateloop should force a submit operation (only once).
	// This environment variable is useful in development. Don't use in production unless you find it fits.
	ForceSubmit bool `env:"FORCE_SUBMIT" envDefault:"false"`
	// ForceResVersion indicates whether updateloop should force the remote resVersion to a specific value (only once).
	// This environment variable is useful in development. Don't use in production unless you find it fits.
	ForceResVersion string `env:"FORCE_RES_VERSION" envDefault:""`
}

func ProvideConfig

func ProvideConfig() (*Config, error)

type ResVersion

type ResVersion string

type Service

type Service struct {
	MainResDir      string
	MainStaticDir   string
	ForceUpdate     bool
	ForceSubmit     bool
	ForceResVersion string

	AvgService   *avg.Service
	AssetService *asset.Service
}

func NewService

func NewService(
	avgS *avg.Service,
	assetS *asset.Service,
	appConf *config.Config,
	conf *Config,
) *Service

func (*Service) AttemptUpdate

func (s *Service) AttemptUpdate(ctx context.Context) error

AttemptUpdate attempts to update the resources.

func (*Service) ResDir

func (s *Service) ResDir(r ResVersion) string

func (*Service) ResVer

func (s *Service) ResVer(ctx context.Context) (ResVersion, ResVersion, error)

func (*Service) StaticDir

func (s *Service) StaticDir(r ResVersion) string

func (*Service) VersioningDir

func (s *Service) VersioningDir(r ResVersion) string