# Option
# Hierarchy
-
↳ Option
# Properties
# allNames
• allNames: string[]
Inherited from OptionSynopsis.allNames
# allNotations
• allNotations: string[]
Inherited from OptionSynopsis.allNotations
# Readonly
boolean
• boolean: boolean
# Readonly
choices
• choices: ParsedOption[]
# Optional
Readonly
default
• default? : ParsedOption
# Readonly
description
• description: string
# kind
• kind: "option"
# Optional
longName
• longName? : undefined | string
Inherited from OptionSynopsis.longName
# Optional
longNotation
• longNotation? : undefined | string
Inherited from OptionSynopsis.longNotation
# name
• name: string
Inherited from OptionSynopsis.name
# notation
• notation: string
Inherited from OptionSynopsis.notation
# Readonly
required
• required: boolean
# Optional
shortName
• shortName? : undefined | string
Inherited from OptionSynopsis.shortName
# Optional
shortNotation
• shortNotation? : undefined | string
Inherited from OptionSynopsis.shortNotation
# synopsis
• synopsis: string
Inherited from OptionSynopsis.synopsis
# Optional
typeHint
• typeHint? : undefined | string
# Optional
Readonly
validator
• validator? : Validator
# valueRequired
• valueRequired: boolean
Inherited from OptionSynopsis.valueRequired
# Optional
valueType
• valueType? : OptionValueType
Inherited from OptionSynopsis.valueType
# variadic
• variadic: boolean
Inherited from OptionSynopsis.variadic
# Readonly
visible
• visible: boolean