winterfx

README

winterFx

A minimalist mesh-native microservice framework with Fx

Donation

View https://guoyk.xyz/donation

Credits

Guo Y.K., MIT License

Documentation

Index

• Variables
• type App
  • func New(opts Options) App
• type Options
• type Params
  • func DecodeParams(fset *flag.FlagSet) (p *Params)

Variables

var (
	// Module is the fx module for winterfx
	Module = fx.Module(
		"winterfx",
		flagfx.Module,
		probefx.Module,
		otelfx.Module,
		fx.Provide(
			flagfx.AsDecoderFunc(DecodeParams),
			New,
		),
	)
)

Types

type App

type App interface {
	// Handler inherit [http.Handler]
	http.Handler
}

App the main interface of [summer]

func New

func New(opts Options) App

New create an App with [Option]

type Options

type Options struct {
	fx.In

	*Params

	probefx.Probe
	routerfx.Router
}

type Params

type Params struct {
	// Listen listen address
	Listen string

	// PathReadiness readiness check path
	PathReadiness string

	// PathLiveness liveness path
	PathLiveness string

	// PathMetrics metrics path
	PathMetrics string

	// DelayStart delay start
	DelayStart time.Duration

	// DelayStop delay stop
	DelayStop time.Duration
}

Params params

func DecodeParams

func DecodeParams(fset *flag.FlagSet) (p *Params)

DecodeParams create Params from flag.FlagSet