Option

ImplyOptionMap alias ImplyOptionMap = OptionVariant[string]: Undocumented in source.
Self alias Self = typeof(this): Undocumented in source.

Functions

choices Self choices(T[] values): set the choices of argument inner type
choices Self choices(T value, T[] rest)
choicesStr string choicesStr(): get the choices in string type, start with choices:
cliVal Self cliVal(string value, string[] rest): set the value from client shell
configVal Self configVal(T value): Undocumented in source. Be warned that the author may not have intended to support it.
configVal Self configVal(T value, T[] rest): Undocumented in source. Be warned that the author may not have intended to support it.
configVal Self configVal(T[] values): Undocumented in source. Be warned that the author may not have intended to support it.
conflictOptStr string conflictOptStr(): get the list of confilt option in string type, start with conflict with
conflicts Self conflicts(string name): specify the name of the option that conflicts with this option
conflicts Self conflicts(string[] names): specify the name of the options that conflicts with this option
defaultVal Self defaultVal(): set the default value true, only for BooleanOption.
defaultVal Self defaultVal(T value): set the default value
defaultVal Self defaultVal(T value, T[] rest): set the default value
defaultVal Self defaultVal(T[] values): set the default value
defaultValStr string defaultValStr(): get the default value in string type, start with default:
description string description(): get the description, and the output starts with description:
description Self description(string desc): set the description
env Self env(string name): set the env variable's key so that the option can set its value from env
envVal Self envVal(): set the option value from en
envValStr string envValStr(): get the env variable's key
get T get(): get inner value in the specified type, T usually is among OptionValueSeq
get T get(): get inner value in the specified type, T usually is among OptionValueSeq
get T get(): get inner value in the specified type, T usually is among OptionValueSeq
hideHelp Self hideHelp(bool hide): set whether the option is hidden out of help command
implies Self implies(string[] names): imply the value of other options' value of true
implies Self implies(string key, T value): imply the value of other option's value of T, T must satisfy isOptionValueType
implyOptStr string implyOptStr(): get the imply map instring type, start with imply
implyVal Self implyVal(): set the imply value as true, which is used for inernal impletation and is not recommended for use in you project
implyVal Self implyVal(OptionVariant value): set the imply value, which is used for inernal impletation and is not recommended for use in you project
implyVal Self implyVal(T value): Undocumented in source. Be warned that the author may not have intended to support it.
implyVal Self implyVal(T value, T[] rest): Undocumented in source. Be warned that the author may not have intended to support it.
implyVal Self implyVal(T[] values): Undocumented in source. Be warned that the author may not have intended to support it.
initialize Self initialize(): initialize the final value. if this.isValid is false, then would throw error
isFlag bool isFlag(string flag): test whether a string is this option's long or short flag
isMerge bool isMerge(): Test is allowed to merge variadic final value from different source, default true
makeMandatory Self makeMandatory(bool mandatory): set whether the option is mandatory
matchFlag bool matchFlag(Option other): test whether the other Option variable's flag same in some parts
matchFlag bool matchFlag(NegateOption other): test whether the other NegateOption variable's flag same in some parts
merge Self merge(bool allow): whether is allowed to merge variadic final value from different source, default true
parser Self parser(): set the parsing function using for transforming from string to T alias fn = T fn(string v), where T is the inner value type
preset Self preset(): set the preset value as true
preset Self preset(T value): preset the value used for value option
preset Self preset(T value, T[] rest): preset the value used for variadic option
preset Self preset(T[] values): preset the value used for variadic option
presetStr string presetStr(): get the preset value in string type, start with preset:
processReducer Self processReducer(): set the reduce process function for reducely processing the value parsed by innner parsing function or process function mainly used in variadic option alias fn = T fn(T v, T t), where T is the inner value type
processor Self processor(): set the process function for processing the value parsed by innner parsing function alias fn = T fn(T v), where T is the inner value type
rangeOf Self rangeOf(T min, T max): set the range of option inner value when the option innner value type is int or double
rangeOfStr string rangeOfStr(): get the range in string type, start with range:
typeStr string typeStr(): get the type in string type, used for help command and help option start with type:

Properties

attrName string attrName [@property getter]: get the attribute name with camel-like
envStr string envStr [@property getter]: get the raw env variable in string type acccording to this.envKey which is set by this.env
get OptionVariant get [@property getter]: get the innner value and is recommended to be used after calling this.initialize()
isBoolean bool isBoolean [@property getter]: test whether is a bool option
isOptional bool isOptional [@property getter]: test whether is optional option
isRequired bool isRequired [@property getter]: Test is required option
isValid bool isValid [@property getter]: test whether the argument is valid so that you can safely get the inner value after the return value is true
name string name [@property getter]: get the name

Variables

_description string _description;: Undocumented in source.
_isMerge bool _isMerge;: Undocumented in source.
conflictsWith string[] conflictsWith;: Undocumented in source.
defaultValueDescription string defaultValueDescription;: Undocumented in source.
envKey string envKey;: Undocumented in source.
flags string flags;: Undocumented in source.
found bool found;: Undocumented in source.
hidden bool hidden;: Undocumented in source.
implyMap ImplyOptionMap implyMap;: Undocumented in source.
innerBoolData bool innerBoolData;: Undocumented in source.
innerImplyData OptionNullable innerImplyData;: Undocumented in source.
isValueData bool isValueData;: Undocumented in source.
longFlag string longFlag;: Undocumented in source.
mandatory bool mandatory;: Undocumented in source.
optional bool optional;: Undocumented in source.
required bool required;: Undocumented in source.
settled bool settled;: Undocumented in source.
shortFlag string shortFlag;: Undocumented in source.
source Source source;: Undocumented in source.
valueName string valueName;: Undocumented in source.
variadic bool variadic;: Undocumented in source.