RouteRegistry
Defined in: src/mft/RouteRegistry.ts:13
Mutable in-memory registry of MFT routes.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RouteRegistry(routes?: Iterable<MftRoute>): RouteRegistry;Defined in: src/mft/RouteRegistry.ts:21
Creates a registry and optionally seeds it with route definitions.
Parameters
Section titled “Parameters”| Parameter | Type | Default value | Description |
|---|---|---|---|
routes | Iterable<MftRoute> | [] | Routes to register immediately. |
Returns
Section titled “Returns”RouteRegistry
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size(): number;Defined in: src/mft/RouteRegistry.ts:115
Returns the number of routes currently registered.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”get(routeId: string): MftRoute | undefined;Defined in: src/mft/RouteRegistry.ts:80
Gets a route definition when registered.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
routeId | string | Route id to retrieve. |
Returns
Section titled “Returns”MftRoute | undefined
The route, or undefined when missing.
has(routeId: string): boolean;Defined in: src/mft/RouteRegistry.ts:70
Checks whether a route id is registered.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
routeId | string | Route id to inspect. |
Returns
Section titled “Returns”boolean
true when a route exists.
list()
Section titled “list()”list(): MftRoute[];Defined in: src/mft/RouteRegistry.ts:110
Returns all registered routes in registration order.
Returns
Section titled “Returns”MftRoute[]
Array of route definitions.
register()
Section titled “register()”register(route: MftRoute): this;Defined in: src/mft/RouteRegistry.ts:34
Registers a route definition.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
route | MftRoute | Route to add. |
Returns
Section titled “Returns”this
This registry for fluent setup.
Throws
Section titled “Throws”ConfigurationError When the route id is already registered or empty.
require()
Section titled “require()”require(routeId: string): MftRoute;Defined in: src/mft/RouteRegistry.ts:91
Gets a route definition or throws a typed SDK error.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
routeId | string | Route id to retrieve. |
Returns
Section titled “Returns”The registered route.
Throws
Section titled “Throws”ConfigurationError When no route is registered under the id.
unregister()
Section titled “unregister()”unregister(routeId: string): boolean;Defined in: src/mft/RouteRegistry.ts:60
Removes a route from the registry.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
routeId | string | Route id to remove. |
Returns
Section titled “Returns”boolean
true when a route was removed.