Interface: RouterBridgeOptions
API / @xmachines/play-router / index / RouterBridgeOptions
Defined in: packages/play-router/src/router-bridge-base.ts:77
What a bridge takes beside the actor and the route map.
It is BasePathOptions with the caches of CompileOptions added: the parse cache AND the compiled cache. A base path and a cache are two different questions, and this type joins them at the ONE place that asks both: the constructor of a bridge.
Extends
Extended by
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
basePath? | readonly | string | The URL prefix that the routes of the machine hang off, for example "/admin" or "/:machineId/play". A :param segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every :param must have a value in BasePathOptions.basePathParams, because the bridge writes a real URL. An optional segment (:param?) and a wildcard (*) are therefore refused: neither of them resolves to one concrete prefix. An absent value, "", and "/" all mean “no prefix”, which is the behaviour of every release before this option existed. | BasePathOptions.basePath | packages/play-url/src/base-path.ts:63 |
basePathParams? | readonly | Record<string, string | number> | The values of the :param segments of BasePathOptions.basePath. These values belong to the HOST, which wrote the prefix and resolved them, so they travel in NO play.route event: the machine is authoritative over its own params, and event.params holds what the pattern of the machine declares, and nothing else. A param of the host that shares a name with one of the machine can therefore shadow it never. A host reads them back from bridge.basePathParams, where they cannot go stale. A machine that needs the identity of its host takes it through the input of the actor, where that identity decides WHICH machine runs. | BasePathOptions.basePathParams | packages/play-url/src/base-path.ts:77 |
compiledCache? | readonly | KeyValueCache<URLPatternLike> | The cache of the COMPILED URLPattern, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass { get: () => undefined, set: () => {} } to compile each time. A caller that passes patternCache for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern. | CompileOptions.compiledCache | packages/play-url/src/url-pattern-utils.ts:119 |
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. | CompileOptions.patternCache | packages/play-pattern/src/cache.ts:41 |