xrouter

type AddHandlerEvent struct {
	Method string
	Path   string
}

type Event interface{}

type MethodNotAllowedHandlerEvent struct {
}

type NotFoundHandlerEvent struct {
}

type Route func(context.Context, http.ResponseWriter, *http.Request)

type Router interface {
	RouterGroup

	// Static adds a directory of static content to serve at root.
	StaticRoot(fs http.Handler)

	// StaticFiles adds a directory of static content to a specific path.
	StaticFiles(path string, fs http.Handler)

	// NotFound adds a handler for routes that don't exist.
	NotFound(http.Handler)

	// MethodNotAllowed handles requests in which the route exists but hte wrong method was used.
	MethodNotAllowed(http.Handler)

	// Handler returns an http.Handler
	Handler() http.Handler

	// EventHandler calls the given function for each handler as it is added to the router.
	EventHandler(func(evt Event))
}

type RouterGroup interface {

	// Use adds middleware to the router.
	Use(f func(next http.Handler) http.Handler)

	// Chain returns the middleware chain.
	Chain() alice.Chain

	// Group returns a new router which strips the given path before the request is handled. All middleware is transferred to the child group.
	Group(path string) RouterGroup

	// Path returns the root path of the RouterGroup
	Path() string

	// GET adds a GET handler at the given path.
	GET(path string, handler Route)

	// POST adds a POST handler at the given path.
	POST(path string, handler Route)

	// PUT adds a PUT handler at the given path.
	PUT(path string, handler Route)

	// OPTIONS adds a OPTIONS handler at the given path.
	OPTIONS(path string, handler Route)

	// HEAD adds a HEAD handler at the given path.
	HEAD(path string, handler Route)

	// PATCH adds a PATCH handler at the given path.
	PATCH(path string, handler Route)

	// DELETE adds a DELETE handler at the given path.
	DELETE(path string, handler Route)
}