Interface: FrameworkParamsSource
API / @xmachines/play-router / index / FrameworkParamsSource
Defined in: packages/play-url/src/framework-params.ts:172
What resolveFrameworkParams needs from the bridge that calls it.
Extends
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
basePath | public | string | The resolved prefix of the mount. "" means that the machine owns the router. | - | packages/play-url/src/framework-params.ts:176 |
pathname? | public | 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:183 |
pattern | public | string | null | undefined | The route pattern of the match, from routeMap.getPathByStateId. | - | packages/play-url/src/framework-params.ts:174 |
patternCache? | readonly | KeyValueCache<ParsedPattern> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | ParseOptions.patternCache | packages/play-pattern/src/cache.ts:41 |
Methods
fallback()
fallback(): Record<string, string>;Defined in: packages/play-url/src/framework-params.ts:187
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:185
The params of the framework router, read lazily and cleaned of empty values.
Returns
Record<string, string>