Interface: RouteMap<CONTEXT>

Route map that stores multiple routes.

Extends

• DocumentedTarget

Type Parameters

• CONTEXT extends CommandContext

Properties

brief

readonly brief: string

Inherited from

DocumentedTarget.brief

Defined in

packages/core/src/routing/types.ts:19

---

formatHelp()

readonly formatHelp: (args) => string

Parameters

• args: HelpFormattingArguments

Returns

string

Inherited from

DocumentedTarget.formatHelp

Defined in

packages/core/src/routing/types.ts:22

---

formatUsageLine()

readonly formatUsageLine: (args) => string

Parameters

• args: UsageFormattingArguments

Returns

string

Inherited from

DocumentedTarget.formatUsageLine

Defined in

packages/core/src/routing/types.ts:21

---

fullDescription

readonly fullDescription: undefined | string

Inherited from

DocumentedTarget.fullDescription

Defined in

packages/core/src/routing/types.ts:20

---

getAllEntries()

readonly getAllEntries: () => readonly RouteMapEntry<CONTEXT>[]

Returns

readonly RouteMapEntry<CONTEXT>[]

Defined in

packages/core/src/routing/route-map/types.ts:28

---

getDefaultCommand()

readonly getDefaultCommand: () => undefined | Command<CONTEXT>

Returns

undefined | Command<CONTEXT>

Defined in

packages/core/src/routing/route-map/types.ts:23

---

getOtherAliasesForInput()

readonly getOtherAliasesForInput: (input, caseStyle) => Readonly<Record<DisplayCaseStyle, readonly string[]>>

Parameters

• input: string

• caseStyle: ScannerCaseStyle

Returns

Readonly<Record<DisplayCaseStyle, readonly string[]>>

Defined in

packages/core/src/routing/route-map/types.ts:24

---

getRoutingTargetForInput()

readonly getRoutingTargetForInput: (input) => undefined | RoutingTarget<CONTEXT>

Parameters

• input: string

Returns

undefined | RoutingTarget<CONTEXT>

Defined in

packages/core/src/routing/route-map/types.ts:22

---

kind

readonly kind: typeof RouteMapSymbol

Defined in

packages/core/src/routing/route-map/types.ts:21