Interface: FrameworkParamsSource
API / @xmachines/play-router / FrameworkParamsSource
Defined in: play-router/src/framework-params.ts:247
What resolveFrameworkParams needs from the bridge that calls it.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
basePath | string | The resolved prefix of the mount. "" means that the machine owns the router. | play-router/src/framework-params.ts:251 |
pathname? | string | The machine-side path of the location, with the mount prefix already removed. The field is OPTIONAL, so a caller that was written before it keeps its behaviour: the one branch that reads it falls back without it, exactly as it did. | play-router/src/framework-params.ts:258 |
pattern | string | null | undefined | The route pattern of the match, from routeMap.getPathByStateId. | play-router/src/framework-params.ts:249 |
Methods
fallback()
fallback(): Record<string, string>;Defined in: play-router/src/framework-params.ts:262
The URLPattern extraction of the base class, read lazily.
Returns
Record<string, string>
frameworkParams()
frameworkParams(): Record<string, string>;Defined in: play-router/src/framework-params.ts:260
The params of the framework router, read lazily and cleaned of empty values.
Returns
Record<string, string>