Router class

The core routing engine for Kronix.

The Router uses a Trie-based structure to efficiently match incoming paths to their registered RouteData. It supports route grouping, middleware, and named parameters.

Constructors

Router()
Creates a new Router instance.

Properties

allRoutes → List<RouteData>
Returns all registered routes and their metadata.
no setter
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

add(String method, String path, Handler handler, {List<Middleware> middleware = const [], String? name}) → RouteData
Registers a standard HTTP route and returns its RouteData.
delete(String path, Handler handler, {List<Middleware> middleware = const [], String? name}) → RouteData
Shorthand to register a DELETE route.
get(String path, Handler handler, {List<Middleware> middleware = const [], String? name}) → RouteData
Shorthand to register a GET route.
group(String prefix, {List<Middleware> middleware = const [], required void callback(Router)}) → void
Registers a group of routes sharing a common prefix and set of middleware.
match(String method, Uri uri) → (RouteData?, Map<String, String>)
Matches the given method and uri against registered routes.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch(String path, Handler handler, {List<Middleware> middleware = const [], String? name}) → RouteData
Shorthand to register a PATCH route.
post(String path, Handler handler, {List<Middleware> middleware = const [], String? name}) → RouteData
Shorthand to register a POST route.
printRoutes() → void
Prints all registered routes to the logger.
put(String path, Handler handler, {List<Middleware> middleware = const [], String? name}) → RouteData
Shorthand to register a PUT route.
toString() → String
A string representation of this object.
inherited
url(String name, {Map<String, dynamic> params = const {}}) → String?
Generates a URL for the given route name and params.
ws(String path, WebSocketHandler handler, {List<Middleware> middleware = const [], String? name}) → RouteData
Registers a WebSocket route and returns its RouteData.

Operators

operator ==(Object other) → bool
The equality operator.
inherited