Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StringOption<Type>

Type parameters

Hierarchy

Index

Properties

autoComplete?: boolean

If autocomplete is enabled. No-op if choices are specified

default

false

choices?: (string | [name: string, value: string])[]

Possible choices for this option. Note that if choices are specified, no other values will be allowed

Choices are an array of numbers of key-value pairs

example
const option = {
choices: ["ts"],
}
// Is the same as
const option = {
choices: [["ts", "ts"]],
}
// You can speficy a better name
const option = {
choices: [["TypeScript", "ts"]],
}
defaultValue?: string

Default value of option. No-op if required is true

description: string
required?: boolean

If option is a required option or not

default

true

type: Type

Generated using TypeDoc