Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Argument<T, I, D>

Template interface to simplify declarations of each command argument type.

T typename is used for string name of the argument type, I is for integer ID of the argument type, and D is for the type of default value, it's set to never (doesn't need to be specified), if the argument of the following type doesn't take default values.

since

3.0

Type Parameters

  • T

  • I

  • D

Hierarchy

Index

Properties

default?: D

Default value for the following argument, sometimes doesn't need to be specified, if the type of argument doesn't take default values.

label: string

Argument's name that will be displayed in command syntax hint text, and also will be used to access its value on command call.

optional?: boolean

Whether the following argument is optional, defaults to false. If you at least once set this property to true, then all the arguments coming after the following one will become optional too.

type: T | I

Integer or string type of the following argument.

Generated using TypeDoc