Skip to main content

Type Alias: FlagItemObject

FlagItemObject = ExtensionProperties & object

A named command option and its constraints.

Type Declaration​

name​

name: string

type​

type: ValueType

aliases?​

optional aliases?: string[]

variadic?​

optional variadic?: boolean

minItems?​

optional minItems?: number

maxItems?​

optional maxItems?: number

choices?​

optional choices?: ChoiceObject[]

hint?​

optional hint?: string

summary?​

optional summary?: string

description?​

optional description?: string

required?​

optional required?: boolean

default?​

optional default?: string | number | boolean

alternativeSources?​

optional alternativeSources?: AlternativeSource[]

hidden?​

optional hidden?: boolean