Enumeration HelpItemConst

The kind of items that can be shown in the option description.

Enumeration Members

append: 5

Reports if an array-valued option can be specified multiple times.

case: 7

The kind of case-conversion applied to string parameters, if enabled.

clusterLetters: 21

The option's cluster letters, if any.

conv: 8

The kind of math conversion applied to number parameters, if enabled.

default: 16

The option's default value, if any.

deprecated: 17

The option's deprecation notice, if any.

desc: 0

The option's synopsis.

enums: 9

Either the enumerated values or the truth and falsity names that the option accepts, if any.

envVar: 19

The option's environment variable, if any.

fallback: 22

The option's fallback value, if any.

inline: 26

The option's treatment of inline parameters, if enabled.

limit: 13

The element count limit of an array-valued option, if enabled.

link: 18

The external resource reference, if any.

negationNames: 1

The negation names of a flag option, if any.

paramCount: 3

Reports the parameter count of a variadic or polyadic option.

positional: 4

Reports if an option accepts positional arguments.

range: 11

The numeric range that number parameters should be within, if enabled.

regex: 10

The regular expression that string parameters should match, if enabled.

required: 15

Reports if the option is always required.

requiredIf: 20

The option's conditional requirements, if any.

requires: 14

The option's requirements, if any.

separator: 2

The element delimiter of an array-valued option, if enabled.

trim: 6

Reports if string parameters will be trimmed (have leading and trailing whitespace removed).

unique: 12

Reports if duplicate elements will be removed from an array-valued option value.

useFilter: 25

Whether a help option uses the remaining arguments as option filter.

useFormat: 24

Whether a help option uses the next argument as the name of a help format.

useNested: 23

Whether a help option uses the next argument as the name of a nested command.