Class RouteInfo public
A RouteInfo is an object that contains metadata about a specific route
within a Transition. It is read-only and internally immutable. It is also
not observable, because a Transition instance is never changed after
creation.
A RouteInfo is not user-constructible; the only legal way to get one is from
a valid Transition. However, you can import the type by using import type
syntax with TypeScript or import() in JSDoc comments.
Methods
find (callback, target*) : Object public
Defined in packages/@ember/routing/route-info.ts:91
- callback
- Function
the callback to execute
- target*
- Object
optional target to use
- returns
- Object
Found item or undefined
Allows you to traverse through the linked list of RouteInfos from the
topmost to leafmost. Returns the first RouteInfo in the linked list for
which the callback returns true.
This method is similar to the find() method defined in ECMAScript 2015.
The callback method you provide should have the following signature (all parameters are optional):
function(item, index, array);itemis the current item in the iteration.indexis the current index in the iteration.arrayis the array itself.
It should return the true to include the item in the results, false
otherwise.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context.
Properties
child public
Defined in packages/@ember/routing/route-info.ts:84
A reference to the child route's RouteInfo. This can be used to traverse
downward to the leafmost RouteInfo.
localName public
Defined in packages/@ember/routing/route-info.ts:40
The final segment of the fully-qualified name of the route, like "index"
metadata public
Defined in packages/@ember/routing/route-info.ts:70
Will contain the result Route#buildRouteInfoMetadata for the corresponding
Route.
name public
Defined in packages/@ember/routing/route-info.ts:34
The dot-separated, fully-qualified name of the route, like "people.index".
paramNames public
Defined in packages/@ember/routing/route-info.ts:55
The ordered list of the names of the params required for this route. It will contain the same strings as Object.keys(params), but here the order is significant. This allows users to correctly pass params into routes programmatically.
params public
Defined in packages/@ember/routing/route-info.ts:46
The values of the route's parameters. These are the same params that are
received as arguments to the route's model hook. Contains only the
parameters valid for this route, if any (params for parent or child routes are
not merged).
parent public
Defined in packages/@ember/routing/route-info.ts:77
A reference to the parent route's RouteInfo. This can be used to traverse
upward to the topmost RouteInfo.
queryParams public
Defined in packages/@ember/routing/route-info.ts:64
The values of any queryParams on this route.