TypedRoute<P, S, D> class abstract interface

A route whose local params, search, and data types are known.

Implemented types
Implementers
Available extensions

Properties

children → List<RouteNode>
Child routes.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasPathCodec → bool
Whether dynamic path values have a typed codec.
no setterinherited
identity → Object
Stable identity shared by compiled route variants.
no setterinherited
metadata → RouteMetadata
Metadata shared by optional route capabilities.
no setterinherited
path → String?
The route's relative or absolute path declaration.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
template → PathTemplate
The parsed path template.
no setterinherited
terminal → bool
Whether this route can be the final match for a location.
no setterinherited

Methods

capability<T extends Object>(RouteCapability<T> key) → T?
Reads an optional capability attached by another package entrypoint.
inherited
decodePath(Map<String, List<String>> values) → Object?
Decodes this route's path parameters.
inherited
decodeQuery(Map<String, List<String>> values) → DecodedSearch<Object?>
Decodes this route's search state.
inherited
encodePath(Object? params) → List<String>
Encodes this route's local path through the generated boundary.
inherited
encodeQuery(Object? search) → Map<String, List<String>>
Encodes this route's local search state.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
ref({required P params, S? search}) → RouteRef<P, S, D>

Available on TypedRoute<P, S, D>, provided by the ParameterizedRouteReference extension

Creates a local route reference.
ref({S? search}) → RouteRef<NoParams, S, D>

Available on TypedRoute<NoParams, S, D>, provided by the StaticRouteReference extension

Creates a local route reference.
to({required P params, S? search}) → Destination

Available on TypedRoute<P, S, D>, provided by the ParameterizedRouteReference extension

Builds a destination containing only this route.
to({S? search}) → Destination

Available on TypedRoute<NoParams, S, D>, provided by the StaticRouteReference extension

Builds a destination containing only this route.
toString() → String
A string representation of this object.
inherited

Operators

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