Results

Namespace

Type

Hierarchy

Index

Properties

Optional choices

choices: Array<string | IOptionChoice<string>>

An array of string choices, or choice objects with separate name and values.

Optional default

default: undefined | false | true

If true, this option will be the first option prompted by the client when filling out this command.

Default: false.

Only one option can be marked as the default.

description

description: string

A 1-100 character description.

Optional name

name: undefined | string

3-32 character command name. By default, the name is the key name in the arguments factory object. If you want, you can override the name shown to the client with this.

Optional required

required: undefined | false | true

If false, the option is optional and becomes nullable.

Default: true.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc