clikt / com.github.ajalt.clikt.parameters.options / transformAll

transformAll

fun Any, ValueT> NullableOption.transformAll(defaultForHelp: String? = this.helpTags[HelpFormatter.Tags.DEFAULT], showAsRequired: Boolean = HelpFormatter.Tags.REQUIRED in this.helpTags, transform: CallsTransformer): OptionWithValues

Transform all calls to the option to the final option type.

The input is a list of calls, one for each time the option appears on the command line. The values in the list are the output of calls to transformValues. If the option does not appear from any source (command line or envvar), this will be called with an empty list.

Used to implement functions like default and multiple.

Parameters

defaultForHelp - The help text for this option’s default value if the help formatter is configured to show them, or null if this option has no default or the default value should not be shown.This does not affect behavior outside of help formatting.

showAsRequired - Tell the help formatter that this option should be marked as required. This does not affect behavior outside of help formatting.