kui_shell_core.UsageRow.md

Kui API Documentation - v11.0.0 / @kui-shell/core / UsageRow

Interface: UsageRow

@kui-shell/core.UsageRow

Table of contents

Properties

• advanced
• alias
• aliases
• allowed
• allowedIsPrefixMatch
• available
• boolean
• booleanOK
• command
• commandPrefix
• commandSuffix
• consumesPositional
• defaultValue
• dir
• docs
• example
• file
• header
• hidden
• implicitOK
• label
• name
• narg
• noclick
• notNeededIfImplicit
• numeric
• partial
• positional
• synonyms
• title

Properties

advanced

• Optional advanced: boolean

Defined in

packages/core/src/core/usage-error.ts:777

---

alias

• Optional alias: string

Defined in

packages/core/src/core/usage-error.ts:746

---

aliases

• Optional aliases: string[]

Defined in

packages/core/src/core/usage-error.ts:775

---

allowed

• Optional allowed: (string | number | boolean)[]

Defined in

packages/core/src/core/usage-error.ts:791

---

allowedIsPrefixMatch

• Optional allowedIsPrefixMatch: boolean

Defined in

packages/core/src/core/usage-error.ts:788

---

available

• Optional available: UsageRow[]

Defined in

packages/core/src/core/usage-error.ts:785

---

boolean

• Optional boolean: boolean

Defined in

packages/core/src/core/usage-error.ts:767

---

booleanOK

• Optional booleanOK: boolean

Defined in

packages/core/src/core/usage-error.ts:764

---

command

• Optional command: string

Defined in

packages/core/src/core/usage-error.ts:741

---

commandPrefix

• Optional commandPrefix: string

Defined in

packages/core/src/core/usage-error.ts:739

---

commandSuffix

• Optional commandSuffix: string

Defined in

packages/core/src/core/usage-error.ts:740

---

consumesPositional

• Optional consumesPositional: boolean

Defined in

packages/core/src/core/usage-error.ts:758

---

defaultValue

• Optional defaultValue: string | number | boolean

Defined in

packages/core/src/core/usage-error.ts:784

---

dir

• Optional dir: boolean

Defined in

packages/core/src/core/usage-error.ts:779

---

docs

• Optional docs: string

Defined in

packages/core/src/core/usage-error.ts:782

---

example

• Optional example: string

Defined in

packages/core/src/core/usage-error.ts:778

---

file

• Optional file: boolean

Defined in

packages/core/src/core/usage-error.ts:773

---

header

• Optional header: string

Defined in

packages/core/src/core/usage-error.ts:781

---

hidden

• Optional hidden: boolean

Defined in

packages/core/src/core/usage-error.ts:776

---

implicitOK

• Optional implicitOK: string[]

Defined in

packages/core/src/core/usage-error.ts:752

---

label

• Optional label: string

Defined in

packages/core/src/core/usage-error.ts:743

---

name

• Optional name: string

Defined in

packages/core/src/core/usage-error.ts:742

---

narg

• Optional narg: number

Defined in

packages/core/src/core/usage-error.ts:749

---

noclick

• Optional noclick: boolean

Defined in

packages/core/src/core/usage-error.ts:744

---

notNeededIfImplicit

• Optional notNeededIfImplicit: boolean

Defined in

packages/core/src/core/usage-error.ts:755

---

numeric

• Optional numeric: boolean

Defined in

packages/core/src/core/usage-error.ts:770

---

partial

• Optional partial: boolean

Defined in

packages/core/src/core/usage-error.ts:783

---

positional

• Optional positional: boolean

Defined in

packages/core/src/core/usage-error.ts:761

---

synonyms

• Optional synonyms: string[]

Defined in

packages/core/src/core/usage-error.ts:745

---

title

• Optional title: string

Defined in

packages/core/src/core/usage-error.ts:780