Framework
RouteDefinition
Route definition with handler and controller info.
Properties are at the route level (not nested under config) per spec.
| Property | Type | Description |
|---|
controller? | { factory: string; import: string; type: string; } | Controller factory information |
controller.factory | string | - |
controller.import | string | - |
controller.type | string | - |
description? | string | Human-readable description |
directory | string | Directory this route scans |
exports? | { config: "required" | "optional" | "forbidden"; default: "required" | "optional" | "forbidden"; named: string[]; } | Export requirements |
exports.config? | "required" | "optional" | "forbidden" | - |
exports.default? | "required" | "optional" | "forbidden" | - |
exports.named? | string[] | - |
filter? | string | File filter pattern (string form of regex) |
handler? | { import: string; type: string; } | Handler type information |
handler.import | string | - |
handler.type | string | - |
key | { nested: "camelCase" | "dotNotation"; separator: string; style: "filename" | "filepath" | "parentOrFilename"; } | Key generation configuration |
key.nested? | "camelCase" | "dotNotation" | - |
key.separator? | string | - |
key.style | "filename" | "filepath" | "parentOrFilename" | - |
multiple? | boolean | Whether multiple handlers per key are allowed |
nesting? | { allowIndex: boolean; catchAllSegment: string; dynamicSegment: string; maxDepth: number; optionalCatchAll: string; } | Nesting configuration |
nesting.allowIndex? | boolean | - |
nesting.catchAllSegment? | string | Catch-all pattern (string form of regex) |
nesting.dynamicSegment? | string | Dynamic segment pattern (string form of regex) |
nesting.maxDepth? | number | - |
nesting.optionalCatchAll? | string | Optional catch-all pattern (string form of regex) |
singular? | string | Singular accessor name (e.g., 'command' for 'commands', 'contextMenu' for 'context') |