Interface: FrameworkParamsSource
API / @xmachines/play-url / index / FrameworkParamsSource
Defined in: packages/play-url/src/framework-params.ts:212
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. | packages/play-url/src/framework-params.ts:216 |
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. | packages/play-url/src/framework-params.ts:223 |
pattern | string | null | undefined | The route pattern of the match, from routeMap.getPathByStateId. | packages/play-url/src/framework-params.ts:214 |
Methods
fallback()
fallback(): Record<string, string>;Defined in: packages/play-url/src/framework-params.ts:227
The URLPattern extraction of the base class, read lazily.
Returns
Record<string, string>
frameworkParams()
frameworkParams(): Record<string, string>;Defined in: packages/play-url/src/framework-params.ts:225
The params of the framework router, read lazily and cleaned of empty values.
Returns
Record<string, string>