class Athena::Console::Input::Argument
inherits Reference
#
Represents a value (or array of values) provided to a command as a ordered positional argument, that can either be required or optional, optionally with a default value and/or description.
Arguments are strings separated by spaces that come after the command name.
For example, ./console test arg1 "Arg2 with spaces".
Arguments can be added via the ACON::Command#argument method,
or by instantiating one manually as part of an ACON::Input::Definition.
The value of the argument could then be accessed via one of the ACON::Input::Interface#argument overloads.
See ACON::Input::Interface for more examples on how arguments/options are parsed, and how they can be accessed.
Constructors#
.new(name : String, mode : ACON::Input::Argument::Mode = :optional, description : String = "", default = nil, suggested_values : Array(String) | Proc(ACON::Completion::Input, Array(String)) | Nil = nil)#
Methods#
#complete(input : ACON::Completion::Input, suggestions : ACON::Completion::Suggestions) : Nil#
Determines what values should be added to the possible suggestions based on the provided input.
#default(type : T.class) : T forall T#
Returns the default value of self, if any, converted to the provided type.
#has_completion? : Bool#
Returns true if this argument is able to suggest values, otherwise false
#is_array? : Bool#
Returns true if self expects an array of values, otherwise false.
ameba:disable Naming/PredicateName