Usage
Signature:
class UrlParamAdapter<P extends {[key: string]: any} = {[key: string]: any}>
Generic Parameters
Parameter Description P Parameters object for the router state
Typescript Import Format
//This class is exported directly as module. To import it
import UrlParamAdapter= require("ojs/ojurlparamadapter");
For additional information visit:
Constructor
new UrlParamAdapter(pathAdapter)
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
pathAdapter |
CoreRouter.UrlAdapter |
<optional> |
An optional path adapter to which this adapter will delegate for translating routes to paths (getUrlForRoutes) and vice-versa (getRoutesForUrl). If not defined, UrlPathAdapter is used. |
Methods
-
getRoutesForUrl(routePathParams) : {Array.<CoreRouter.Route.<P>>}
-
Build all routes for the current router query parameter.
Parameters:
Name Type Argument Description routePathParams
object <optional>
An optional object that may be passed by the route to parse the route path parameters for the active state. See UrlAdapter#getRoutesForUrl for details. Returns:
An array of route path parameter names. See UrlAdapter#getRoutesForUrl for details.
- Type
- Array.<CoreRouter.Route.<P>>
-
getUrlForRoutes(routes) : {string}
-
Build the URL path for the given routes. See UrlAdapter#getUrlForRoutes for details.
Parameters:
Name Type Description routes
Array.<CoreRouter.Route.<P>> The set of routes from which the URL will be built. Returns:
The full URL representing of the given routes
- Type
- string