Interface: UsageModel
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/core / UsageModel
Interface: UsageModel
@kui-shell/core.UsageModel
Hierarchy
-
CapabilityRequirements↳
UsageModel
Table of contents
Properties
- available
- breadcrumb
- children
- command
- commandPrefix
- commandPrefixNotNeeded
- commandSuffix
- configuration
- detailedExample
- docs
- example
- fullscreen
- header
- hide
- intro
- nRowsInViewport
- needsUI
- noAuthOk
- noHelp
- noHelpAlias
- oneof
- onlyEnforceOptions
- optional
- parents
- preserveCase
- related
- required
- requiresLocal
- sampleInputs
- sections
- strict
- synonymFor
- synonyms
- title
Methods
Properties
available
• Optional available: UsageRow[]
Defined in
packages/core/src/core/usage-error.ts:852
breadcrumb
• Optional breadcrumb: string
Defined in
packages/core/src/core/usage-error.ts:835
children
• Optional children: Record<string, { route: string ; usage?: UsageModel }>
Defined in
packages/core/src/core/usage-error.ts:831
command
• Optional command: string
Defined in
packages/core/src/core/usage-error.ts:837
commandPrefix
• Optional commandPrefix: string
Defined in
packages/core/src/core/usage-error.ts:846
commandPrefixNotNeeded
• Optional commandPrefixNotNeeded: boolean
Defined in
packages/core/src/core/usage-error.ts:847
commandSuffix
• Optional commandSuffix: string
Defined in
packages/core/src/core/usage-error.ts:848
configuration
• Optional configuration: YargsParserConfiguration
Defined in
packages/core/src/core/usage-error.ts:828
detailedExample
• Optional detailedExample: DetailedExample | DetailedExample[]
Defined in
packages/core/src/core/usage-error.ts:842
docs
• Optional docs: string
Defined in
packages/core/src/core/usage-error.ts:839
example
• Optional example: string
Defined in
packages/core/src/core/usage-error.ts:841
fullscreen
• Optional fullscreen: boolean
Inherited from
CapabilityRequirements.fullscreen
Defined in
packages/core/src/models/command.ts:262
header
• Optional header: string
Defined in
packages/core/src/core/usage-error.ts:840
hide
• Optional hide: boolean
Defined in
packages/core/src/core/usage-error.ts:830
intro
• Optional intro: TitledContent
Defined in
packages/core/src/core/usage-error.ts:844
nRowsInViewport
• Optional nRowsInViewport: number | boolean
Defined in
packages/core/src/core/usage-error.ts:856
needsUI
• Optional needsUI: boolean
Inherited from
CapabilityRequirements.needsUI
Defined in
packages/core/src/models/command.ts:259
noAuthOk
• Optional noAuthOk: boolean | string[]
Inherited from
CapabilityRequirements.noAuthOk
Defined in
packages/core/src/models/command.ts:261
noHelp
• Optional noHelp: boolean
Defined in
packages/core/src/core/usage-error.ts:819
noHelpAlias
• Optional noHelpAlias: boolean
Defined in
packages/core/src/core/usage-error.ts:822
oneof
• Optional oneof: UsageRow[]
Defined in
packages/core/src/core/usage-error.ts:855
onlyEnforceOptions
• Optional onlyEnforceOptions: boolean | string[]
Defined in
packages/core/src/core/usage-error.ts:825
optional
• Optional optional: UsageRow[]
Defined in
packages/core/src/core/usage-error.ts:854
parents
• Optional parents: BreadcrumbLabel[]
Defined in
packages/core/src/core/usage-error.ts:850
preserveCase
• Optional preserveCase: boolean
Defined in
packages/core/src/core/usage-error.ts:849
related
• Optional related: string[]
Defined in
packages/core/src/core/usage-error.ts:851
required
• Optional required: UsageRow[]
Defined in
packages/core/src/core/usage-error.ts:853
requiresLocal
• Optional requiresLocal: boolean
Inherited from
CapabilityRequirements.requiresLocal
Defined in
packages/core/src/models/command.ts:260
sampleInputs
• Optional sampleInputs: UsageRow[]
Defined in
packages/core/src/core/usage-error.ts:843
sections
• Optional sections: UsageSection[]
Defined in
packages/core/src/core/usage-error.ts:845
strict
• Optional strict: string
Defined in
packages/core/src/core/usage-error.ts:838
synonymFor
• Optional synonymFor: string
Defined in
packages/core/src/core/usage-error.ts:832
synonyms
• Optional synonyms: string[]
Defined in
packages/core/src/core/usage-error.ts:833
title
• Optional title: string
Defined in
packages/core/src/core/usage-error.ts:836
Methods
fn
▸ Optional fn(command): UsageModel
Parameters
| Name | Type |
|---|---|
command | string |