Interface: ConnectRouterOptions
API / @xmachines/play-dom-router / ConnectRouterOptions
Defined in: play-dom-router/src/connect-router.ts:24
The options of connectRouter.
Extends
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
actor | readonly | RoutableActor | The actor to keep in step with the browser URL. It must implement Routable. | - | play-dom-router/src/connect-router.ts:26 |
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. | RouterBridgeOptions.basePath | play-url/src/base-path.ts:62 |
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. | RouterBridgeOptions.basePathParams | play-url/src/base-path.ts:76 |
compiledCache? | readonly | PatternCache<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. | RouterBridgeOptions.compiledCache | play-url/src/url-pattern-utils.ts:119 |
patternCache? | readonly | PatternCache<ParsedPattern> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | RouterBridgeOptions.patternCache | play-pattern/src/cache.ts:40 |
routeMap | readonly | RouteLookupContract | The route lookup that matches a URL pathname to a machine state ID. | - | play-dom-router/src/connect-router.ts:40 |
router | readonly | Pick<VanillaRouter, "history"> | The vanilla router from createRouter. The type states the HISTORY alone, because that is what this function reads: the bridge takes location for the first synchronization, it writes each navigation with push, and it watches the browser with subscribe. It calls destroy never, and it releases the history never — the owner of the history does that. A whole VanillaRouter satisfies it, and a caller that holds one passes it as it always did. A caller that holds a history and no router passes { history }. | - | play-dom-router/src/connect-router.ts:38 |