Interface Router<T>

Router defines a thin wrapper around the standard Go [http.ServeMux] by adding support for routing sub-groups, middlewares and other common utils.

Example:

  r := NewRouter[*MyEvent](eventFactory)

  // middlewares
  r.BindFunc(m1, m2)

  // routes
  r.GET("/test", handler1)

  // sub-routers/groups
  api := r.Group("/api")
  api.GET("/admins", handler2)

  // generate a http.ServeMux instance based on the router configurations
  mux, _ := r.BuildMux()

  http.ListenAndServe("localhost:8090", mux)

Type Parameters

Hierarchy

_subdyfvO<T>
- Router

Index

Methods

any bind bindFunc buildMux delete get group hasRoute head options patch post put route search unbind

Properties

middlewares prefix

Methods

any

any(path, action): Route<T>
Any is a shorthand for [RouterGroup.AddRoute] with "" as route method (aka. matches any method).
Parameters
- path: string
- action: ((e) => void)
  - - (e): void
    - Parameters
      
      e: T
      
      Returns void
Returns Route<T>
Inherited from _subdyfvO.any
- Defined in types.d.ts:23152

bind

bind(...middlewares): RouterGroup<T>
Bind registers one or multiple middleware handlers to the current group.
Parameters
- Rest ...middlewares: hook.Handler<T>[]
Returns RouterGroup<T>
Inherited from _subdyfvO.bind
- Defined in types.d.ts:23124

bindFunc

bindFunc(...middlewareFuncs): RouterGroup<T>
BindFunc registers one or multiple middleware functions to the current group.

The registered middleware functions are "anonymous" and with default priority, aka. executes in the order they were registered.

If you need to specify a named middleware (ex. so that it can be removed) or middleware with custom exec prirority, use [RouterGroup.Bind] method.
Parameters
- Rest ...middlewareFuncs: ((e) => void)[]
Returns RouterGroup<T>
Inherited from _subdyfvO.bindFunc
- Defined in types.d.ts:23118

buildMux

buildMux(): http.Handler
BuildMux constructs a new mux [http.Handler] instance from the current router configurations.

Returns http.Handler
- Defined in types.d.ts:19766

delete

delete(path, action): Route<T>
DELETE is a shorthand for [RouterGroup.AddRoute] with DELETE as route method.
Parameters
- path: string
- action: ((e) => void)
  - - (e): void
    - Parameters
      
      e: T
      
      Returns void
Returns Route<T>
Inherited from _subdyfvO.delete
- Defined in types.d.ts:23176

get

get(path, action): Route<T>
GET is a shorthand for [RouterGroup.AddRoute] with GET as route method.
Parameters
- path: string
- action: ((e) => void)
  - - (e): void
    - Parameters
      
      e: T
      
      Returns void
Returns Route<T>
Inherited from _subdyfvO.get
- Defined in types.d.ts:23158

group

group(prefix): RouterGroup<T>
Group creates and register a new child Group into the current one with the specified prefix.

The prefix follows the standard Go net/http ServeMux pattern format ("[HOST]/[PATH]") and will be concatenated recursively into the final route path, meaning that only the root level group could have HOST as part of the prefix.

Returns the newly created group to allow chaining and registering sub-routes and group specific middlewares.
Parameters
- prefix: string
Returns RouterGroup<T>
Inherited from _subdyfvO.group
- Defined in types.d.ts:23106

hasRoute

hasRoute(method, path): boolean
HasRoute checks whether the specified route pattern (method + path) is registered in the current group or its children.

This could be useful to conditionally register and checks for routes in order prevent panic on duplicated routes.

Note that routes with anonymous and named wildcard placeholder are treated as equal, aka. "GET /abc/" is considered the same as "GET /abc/{something...}".
Parameters
- method: string
- path: string
Returns boolean
Inherited from _subdyfvO.hasRoute
- Defined in types.d.ts:23213

head

head(path, action): Route<T>
HEAD is a shorthand for [RouterGroup.AddRoute] with HEAD as route method.
Parameters
- path: string
- action: ((e) => void)
  - - (e): void
    - Parameters
      
      e: T
      
      Returns void
Returns Route<T>
Inherited from _subdyfvO.head
- Defined in types.d.ts:23194

options

options(path, action): Route<T>
OPTIONS is a shorthand for [RouterGroup.AddRoute] with OPTIONS as route method.
Parameters
- path: string
- action: ((e) => void)
  - - (e): void
    - Parameters
      
      e: T
      
      Returns void
Returns Route<T>
Inherited from _subdyfvO.options
- Defined in types.d.ts:23200

patch

patch(path, action): Route<T>
PATCH is a shorthand for [RouterGroup.AddRoute] with PATCH as route method.
Parameters
- path: string
- action: ((e) => void)
  - - (e): void
    - Parameters
      
      e: T
      
      Returns void
Returns Route<T>
Inherited from _subdyfvO.patch
- Defined in types.d.ts:23182

post

post(path, action): Route<T>
POST is a shorthand for [RouterGroup.AddRoute] with POST as route method.
Parameters
- path: string
- action: ((e) => void)
  - - (e): void
    - Parameters
      
      e: T
      
      Returns void
Returns Route<T>
Inherited from _subdyfvO.post
- Defined in types.d.ts:23170

put

put(path, action): Route<T>
PUT is a shorthand for [RouterGroup.AddRoute] with PUT as route method.
Parameters
- path: string
- action: ((e) => void)
  - - (e): void
    - Parameters
      
      e: T
      
      Returns void
Returns Route<T>
Inherited from _subdyfvO.put
- Defined in types.d.ts:23188

route

route(method, path, action): Route<T>
Route registers a single route into the current group.

Note that the final route path will be the concatenation of all parent groups prefixes + the route path. The path follows the standard Go net/http ServeMux format ("[HOST]/[PATH]"), meaning that only a top level group route could have HOST as part of the prefix.

Returns the newly created route to allow attaching route-only middlewares.
Parameters
- method: string
- path: string
- action: ((e) => void)
  - - (e): void
    - Parameters
      
      e: T
      
      Returns void
Returns Route<T>
Inherited from _subdyfvO.route
- Defined in types.d.ts:23146

search

search(path, action): Route<T>
SEARCH is a shorthand for [RouterGroup.AddRoute] with SEARCH as route method.
Parameters
- path: string
- action: ((e) => void)
  - - (e): void
    - Parameters
      
      e: T
      
      Returns void
Returns Route<T>
Inherited from _subdyfvO.search
- Defined in types.d.ts:23164

unbind

unbind(...middlewareIds): RouterGroup<T>
Unbind removes one or more middlewares with the specified id(s) from the current group and its children (if any).

Anonymous middlewares are not removable, aka. this method does nothing if the middleware id is an empty string.
Parameters
- Rest ...middlewareIds: string[]
Returns RouterGroup<T>
Inherited from _subdyfvO.unbind
- Defined in types.d.ts:23134

Interface Router<T>

Type Parameters

T

Hierarchy

Index

Methods

Properties

Methods

any

Parameters

path: string

action: ((e) => void)

Parameters

e: T

Returns void

Returns Route<T>

bind

Parameters

Rest ...middlewares: hook.Handler<T>[]

Returns RouterGroup<T>

bindFunc

Parameters

Rest ...middlewareFuncs: ((e) => void)[]

Returns RouterGroup<T>

buildMux

Returns http.Handler

delete

Parameters

path: string

action: ((e) => void)

Parameters

e: T

Returns void

Returns Route<T>

get

Parameters

path: string

action: ((e) => void)

Parameters

e: T

Returns void

Returns Route<T>

group

Parameters

prefix: string

Returns RouterGroup<T>

hasRoute

Parameters

method: string

path: string

Returns boolean

head

Parameters

path: string

action: ((e) => void)

Parameters

e: T

Returns void

Returns Route<T>

options

Parameters

path: string

action: ((e) => void)

Parameters

e: T

Returns void

Returns Route<T>

patch

Parameters

path: string

action: ((e) => void)

Parameters

e: T

Returns void

Returns Route<T>

post

Parameters

path: string

action: ((e) => void)

Parameters

`Rest` ...middlewares: hook.Handler<T>[]

`Rest` ...middlewareFuncs: ((e) => void)[]

`Rest` ...middlewareIds: string[]