systemfx

package

v0.0.0-...-6b7fec4 Latest Latest Go to latest Published: Aug 3, 2023 License: MIT Imports: 4 Imported by: 0

Details

This section is empty.

View Source

var Module = fx.Options(fx.Provide(New), fx.Invoke(RegisterHealthCheck))

Module starts an HTTP server and returns a http.ServeMux to use to register handlers for the server.

func RegisterHealthCheck(p RegisterRouteParams)

type Params struct {
	fx.In

	Lifecycle  fx.Lifecycle
	Shutdowner fx.Shutdowner
	Logger     *zap.Logger
}

Params defines the dependencies of the httpfx module.

type RegisterRouteParams struct {
	fx.In

	Mux *http.ServeMux `name:"system"`
}

type Result struct {
	fx.Out

	Mux *http.ServeMux `name:"system"`
}

Result defines the objects that the httpfx module provides.

func New(p Params) (Result, error)

New exports functionality similar to Module, but allows the caller to wrap or modify Result. Most users should use Module instead.