Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RoutingObject

Routing instance with navigation objects and functions.

Hierarchy

  • RoutingObject

Index

Properties

childRoute

childRoute: function

returns the Route for the current route plus the given child route.

Type declaration

childSegment

childSegment: RouteSegment

the RouteSegment for the child route.

index

index: number

the route index, used internally.

localSegment

localSegment: RouteSegment

the RouteSegment for the local route.

next

next: function

returns the RoutingObject for the next child.

Type declaration

parentRoute

parentRoute: function

returns the parent Route.

Type declaration

route

route: Route

the current Route.

sameRoute

sameRoute: function

returns the same route with the given params.

Type declaration

    • (params: Record<string, any>): Route
    • Parameters

      • params: Record<string, any>

      Returns Route

siblingRoute

siblingRoute: function

returns the Route for the current route plus the given sibling route.

Type declaration

Generated using TypeDoc