Module: lib/router
Interfaces
Variables
NotFoundRoute
• Const
NotFoundRoute: Object
Type declaration
Name | Type |
---|---|
component |
() => Element |
exact |
boolean |
name |
string |
noAuthRequired |
boolean |
path |
string |
sidebar |
null |
Defined in
Functions
createRouteURL
▸ createRouteURL(routeName
, params?
): string
Parameters
Name | Type |
---|---|
routeName |
string |
params |
RouteURLProps
|
Returns
string
Defined in
getDefaultRoutes
▸ getDefaultRoutes(): Object
Returns
Object
Defined in
getRoute
▸ getRoute(routeName
):
Route
Parameters
Name | Type |
---|---|
routeName |
string |
Returns
Defined in
getRoutePath
▸ getRoutePath(route
): string
Parameters
Name | Type |
---|---|
route |
Route
|
Returns
string
Defined in
getRouteUseClusterURL
▸ getRouteUseClusterURL(route
): boolean
Should the route use a cluster URL?
Parameters
Name | Type |
---|---|
route |
Route
|
Returns
boolean
true when a cluster URL contains cluster in the URL. eg. /c/minikube/my-url false, the URL does not contain the cluster. eg. /my-url