Enumeration HelpItemConst

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

Enumeration Members

_count: 21

The number of help items (for internal use only). New enumerators should be added in their intended position.

append: 6

Whether an array-valued option can be specified multiple times.

choices: 7

The option's parameter choices.

cluster: 1

The option's cluster letters.

default: 16

The option's default value.

deprecated: 19

The option's deprecation notice.

inline: 5

The option's treatment of inline parameters.

limit: 10

The element count limit of an array-valued option.

link: 20

The option's external resource hyperlink.

paramCount: 2

The parameter count of a variadic or polyadic option.

positional: 4

Whether the option accepts positional arguments.

regex: 8

The regular expression that parameters should match.

required: 14

Whether the option is always required.

requiredIf: 15

The option's conditional requirements.

requires: 13

The option's forward requirements.

separator: 3

The parameter delimiter of an array-valued option.

sources: 12

The option's environment data sources.

stdin: 11

Whether the option accepts data from standard input.

synopsis: 0

The option's synopsis.

unique: 9

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

useCommand: 17

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

useFilter: 18

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