Usage
Signature:
interface CoreRouterState<D extends Record<string, any> = Record<string, any>, P extends Record<string, any> = Record<string, any>>
Generic Parameters
Parameter Description D Detail object for the router state P Parameters object for the router state
Typescript Import Format
//To use this interface, import as below.
import CoreRouter= require("ojs/ojcorerouter");
//To access this interface in your code,
let myVariable: CoreRouter.CoreRouterState;
For additional information visit:
An interface describing the object used by CoreRouter to represent
the routes and associated information to which it can navigate.
Fields
-
(readonly) detail :D
-
The detail object for the state, if configured.
-
(readonly) params :P
-
Parameters for the state. Parameters are passed to the state via the CoreRouter#go method.
-
(readonly) path :string
-
The path of the state. This will always be the string used to navigate to the current state, even if the original path for the route was defined as a RegExp.
-
(readonly) pathParams :string[]
-
Path parameter names for the state, ordered in the order in which they were defined in the route. The names do not include the braces.
-
(readonly) redirect :string
-
A redirect path, if configured. This is taken from the original route configuration, and may be undefined.