command argument_object

This object contains all information regarding an argument to the command handler.

Fields

count number or string

The amount of recurrences of the argument. '*' if arbitrary. If the argument is marked as required, '*' implies at least one.

default any

Default value to use for optional parameters which are not provided. Has to be nil on a required parameter.

name string

The name of the parameter. This is only used in syntax generation and does not need to correspond to the named variable of the function.

options table

Table of options to pass to the argument.type.check and argument.type.generate functions.

required boolean

true if the argument is required, false if not.

type argument_type

The type object representing the argument.