addOption method

void addOption(
  1. String name, {
  2. String? abbr,
  3. String? help,
  4. String? valueHelp,
  5. Iterable<String>? allowed,
  6. Map<String, String>? allowedHelp,
  7. String? defaultsTo,
  8. void callback(
    1. String?
    )?,
  9. bool mandatory = false,
  10. bool hide = false,
  11. List<String> aliases = const [],
})

Defines an option that takes a value.

This adds an Option with the given properties to options.

The abbr argument is a single-character string that can be used as a shorthand for this option. For example, abbr: "a" will allow the user to pass -a value or -avalue.

The help argument is used by usage to describe this option.

The valueHelp argument is used by usage as a name for the value this option takes. For example, valueHelp: "FOO" will include --option=<FOO> rather than just --option in the usage string.

The allowed argument is a list of valid values for this option. If it's non-null and the user passes a value that's not included in the list, parse will throw a FormatException. The allowed values will also be included in usage.

The allowedHelp argument is a map from values in allowed to documentation for those values that will be included in usage. The map may include a subset of the allowed values. Additional values that are not in allowed should be omitted, however there is no validation. When both allowed and allowedHelp are passed, only allowed will be validated at parse time, and only allowedHelp will be included in usage output.

The defaultsTo argument indicates the value this option will have if the user doesn't explicitly pass it in (or null by default).

The callback argument is invoked with the option's value when the option is parsed, or with null if the option was not parsed. Note that this makes argument parsing order-dependent in ways that are often surprising, and its use is discouraged in favor of reading values from the ArgResults.

If hide is true, this option won't be included in usage.

If aliases is provided, these are used as aliases for name. These aliases will not appear as keys in the options map.

Throws an ArgumentError if:

  • There is already an option with name name.
  • There is already an option using abbreviation abbr.

Implementation

void addOption(String name,
    {String? abbr,
    String? help,
    String? valueHelp,
    Iterable<String>? allowed,
    Map<String, String>? allowedHelp,
    String? defaultsTo,
    void Function(String?)? callback,
    bool mandatory = false,
    bool hide = false,
    List<String> aliases = const []}) {
  _addOption(name, abbr, help, valueHelp, allowed, allowedHelp, defaultsTo,
      callback, OptionType.single,
      mandatory: mandatory, hide: hide, aliases: aliases);
}