router library
Platform-neutral typed routing, matching, and URL generation.
Classes
-
AppRoute<
P, S, D> - A typed route definition shared by manual and file routing.
-
DecodedSearch<
S> - The result of decoding one route's search state.
- Destination
- An immutable navigation target.
- NoData
- The absence of route loader data.
- NoParams
- The absence of path parameters.
- NoSearch
- The absence of typed search state.
- PathInput
- Read-only access to raw path parameters.
- PathOutput
- Collects encoded path parameters.
-
PathParams<
P> - A bidirectional typed path-parameter contract.
- PathTemplate
- The reversible subset of Roux path syntax used by typed destinations.
- RouteBranch
- The matched root-to-leaf route branch.
-
RouteCapability<
T extends Object> - A typed key used by optional packages to extend a route definition.
- RouteLoadResult
- The outcome of one route loader.
-
RouteMatch<
P, S, D> - One typed route match.
- RouteMatcher
- Matches locations against an immutable route tree.
- RouteMatches
- The ordered matches for one location.
- RouteMetadata
- Descriptive route information shared by every runtime.
- RouteNode
- A node stored in a route tree.
-
RouteRef<
P, S, D> - One strongly typed, locally bound route reference.
- RouteRefPath
- An ordered branch of strongly typed route references.
-
RouteValues<
P, S> - Typed params and search belonging to one active route.
- SearchInput
- Read-only access to a URI query multimap.
- SearchOutput
- Collects encoded query values in canonical field order.
-
SearchParams<
S> - A bidirectional typed search-state contract.
-
TypedRoute<
P, S, D> - A route whose local params, search, and data types are known.
Enums
- InvalidSearchBehavior
- The behavior used when a URL contains invalid search values.
Extensions
-
ParameterizedRouteReference
on TypedRoute<
P, S, D> - Binds params and search to a typed route.
-
StaticRouteReference
on TypedRoute<
NoParams, S, D> - Binds search to a typed route without path parameters.
Exceptions / Errors
- ParameterFormatException
- An error produced while decoding path or search values.
- PathSyntaxException
- Invalid syntax in a typed route path.
- SearchParameterFormatException
- A strict search-parameter decoding failure.