Interface: Command<CONTEXT>

Parsed and validated command instance.

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

---

kind

readonly kind: typeof CommandSymbol

Defined in

packages/core/src/routing/command/types.ts:49

---

loader

readonly loader: CommandFunctionLoader<Readonly<Record<string, unknown>>, BaseArgs, CONTEXT>

Defined in

packages/core/src/routing/command/types.ts:50

---

parameters

readonly parameters: CommandParameters

Defined in

packages/core/src/routing/command/types.ts:51

---

usesFlag()

readonly usesFlag: (flagName, caseStyle) => boolean

Parameters

• flagName: string

• caseStyle: ScannerCaseStyle

Returns

boolean

Defined in

packages/core/src/routing/command/types.ts:52