router

Documentation

Index

• func RenderError(ctx context.Context, w http.ResponseWriter, err errors.CustomError)
• func RenderJSON(ctx context.Context, w http.ResponseWriter, httpStatusCode int, payload any)
• type HTTPRouter
  • func NewHTTPRouter(cfgs config.ServerConfigurations) *HTTPRouter
  • func (s *HTTPRouter) Shutdown(ctx context.Context)
  • func (s *HTTPRouter) Start()

Functions

func RenderError

func RenderError(ctx context.Context, w http.ResponseWriter, err errors.CustomError)

RenderError Renders an error with some sane defaults.

func RenderJSON

func RenderJSON(ctx context.Context, w http.ResponseWriter, httpStatusCode int, payload any)

RenderJSON is a helper function to write a JSON response

Types

type HTTPRouter

type HTTPRouter struct {
	Mux *chi.Mux
	// contains filtered or unexported fields
}

func NewHTTPRouter

func NewHTTPRouter(cfgs config.ServerConfigurations) *HTTPRouter

func (*HTTPRouter) Shutdown

func (s *HTTPRouter) Shutdown(ctx context.Context)

func (*HTTPRouter) Start

func (s *HTTPRouter) Start()