Table of Contents - tty-option-0.2.0 Documentation
Pages
- CHANGELOG
- LICENSE
-
README
- TTY::Option
- Features
- Installation
- Contents
- 1. Usage
- 2. API
- 2.1 argument
- 2.2 keyword
- 2.3 option
- 2.4 environment
- 2.5.2 convert
- => [true, false, true]
- => {:a=>1, :b=>2, :c=>3}
- 2.5.3 default
- 2.5.4 desc(ription)
- 2.5.5 hidden
- 2.5.6 name
- => AggregateErors
- 2.7.2 remaining
- 2.7.3 valid?
- 2.8 usage
- 2.8.1 header
- 2.8.2 program
- 2.9.4 :param_display
- 2.9.5 :width
- Development
- Contributing
- License
- Code of Conduct
- Copyright
Classes and Modules
- TTY
- TTY::Option
- TTY::Option::AggregateErrors
- TTY::Option::Const
- TTY::Option::Conversions
- TTY::Option::Converter
- TTY::Option::DSL
- TTY::Option::DSL::Arity
- TTY::Option::DSL::Conversion
- TTY::Option::DeepDup
- TTY::Option::ErrorAggregator
- TTY::Option::Formatter
- TTY::Option::Inflection
- TTY::Option::Inheritance
- TTY::Option::Interface
- TTY::Option::InvalidArgument
- TTY::Option::InvalidArity
- TTY::Option::InvalidConversionArgument
- TTY::Option::MissingArgument
- TTY::Option::MissingParameter
- TTY::Option::ParamConversion
- TTY::Option::ParamPermitted
- TTY::Option::ParamValidation
- TTY::Option::Parameter
- TTY::Option::Parameter::Argument
- TTY::Option::Parameter::Environment
- TTY::Option::Parameter::Keyword
- TTY::Option::Parameter::Option
- TTY::Option::Parameters
- TTY::Option::Params
- TTY::Option::ParseError
- TTY::Option::Parser
- TTY::Option::Parser::Arguments
- TTY::Option::Parser::ArityCheck
- TTY::Option::Parser::Environments
- TTY::Option::Parser::Keywords
- TTY::Option::Parser::Options
- TTY::Option::Parser::ParamTypes
- TTY::Option::Parser::RequiredCheck
- TTY::Option::Pipeline
- TTY::Option::Result
- TTY::Option::Result::Failure
- TTY::Option::Result::Success
- TTY::Option::Section
- TTY::Option::Sections
- TTY::Option::UnpermittedArgument
- TTY::Option::Usage
- TTY::Option::UsageWrapper
Methods
- ::[] — TTY::Option::ParamConversion
- ::[] — TTY::Option::ParamPermitted
- ::[] — TTY::Option::ParamValidation
- ::call — TTY::Option::ParamConversion
- ::call — TTY::Option::ParamPermitted
- ::call — TTY::Option::ParamValidation
- ::create — TTY::Option::Parameter
- ::create — TTY::Option::Params
- ::create — TTY::Option::Usage
- ::dasherize — TTY::Option::Inflection
- ::deep_dup — TTY::Option::DeepDup
- ::deep_dup_array — TTY::Option::DeepDup
- ::deep_dup_hash — TTY::Option::DeepDup
- ::define_param_query — TTY::Option::Parameters
- ::define_query — TTY::Option::Parameters
- ::demodulize — TTY::Option::Inflection
- ::failure — TTY::Option::Result
- ::help — TTY::Option::Formatter
- ::included — TTY::Option
- ::new — TTY::Option::AggregateErrors
- ::new — TTY::Option::ErrorAggregator
- ::new — TTY::Option::InvalidArgument
- ::new — TTY::Option::InvalidArity
- ::new — TTY::Option::InvalidConversionArgument
- ::new — TTY::Option::MissingArgument
- ::new — TTY::Option::MissingParameter
- ::new — TTY::Option::UnpermittedArgument
- ::new — TTY::Option::Formatter
- ::new — TTY::Option::Parameter
- ::new — TTY::Option::Parameters
- ::new — TTY::Option::Params
- ::new — TTY::Option::Parser
- ::new — TTY::Option::Parser::Arguments
- ::new — TTY::Option::Parser::ArityCheck
- ::new — TTY::Option::Parser::Environments
- ::new — TTY::Option::Parser::Keywords
- ::new — TTY::Option::Parser::Options
- ::new — TTY::Option::Parser::RequiredCheck
- ::new — TTY::Option::Pipeline
- ::new — TTY::Option::Result::Success
- ::new — TTY::Option::Result::Failure
- ::new — TTY::Option::Section
- ::new — TTY::Option::Sections
- ::new — TTY::Option::Usage
- ::next_line — TTY::Option::UsageWrapper
- ::success — TTY::Option::Result
- ::underscore — TTY::Option::Inflection
- ::wrap — TTY::Option::UsageWrapper
- #<< — TTY::Option::Parameters
- #<< — TTY::Option::Parser::ArityCheck
- #<< — TTY::Option::Parser::RequiredCheck
- #<=> — TTY::Option::Parameter
- #<=> — TTY::Option::Parameter::Environment
- #<=> — TTY::Option::Parameter::Option
- #== — TTY::Option::Parameter
- #== — TTY::Option::Params
- #[] — TTY::Option::Params
- #[] — TTY::Option::Sections
- #[] — TTY::Option::Converter
- #[] — TTY::Option::ParamConversion
- #[] — TTY::Option::ParamPermitted
- #[] — TTY::Option::ParamValidation
- #[]= — TTY::Option::Params
- #add — TTY::Option::AggregateErrors
- #add — TTY::Option::Parameters
- #add — TTY::Option::Parser::ArityCheck
- #add — TTY::Option::Parser::RequiredCheck
- #add — TTY::Option::Sections
- #add_after — TTY::Option::Sections
- #add_before — TTY::Option::Sections
- #any — TTY::Option::DSL::Arity
- #any_args — TTY::Option::DSL::Arity
- #argument — TTY::Option::DSL
- #argument? — TTY::Option::Parser::ParamTypes
- #argument_optional? — TTY::Option::Parameter::Option
- #argument_required? — TTY::Option::Parameter::Option
- #arity — TTY::Option::Parameter
- #assign_argument — TTY::Option::Parser::Arguments
- #assign_envvar — TTY::Option::Parser::Environments
- #assign_keyword — TTY::Option::Parser::Keywords
- #assign_option — TTY::Option::Parser::Options
- #at_least — TTY::Option::DSL::Arity
- #banner — TTY::Option::Usage
- #banner? — TTY::Option::Usage
- #call — TTY::Option::ErrorAggregator
- #call — TTY::Option::Parser::ArityCheck
- #call — TTY::Option::Parser::RequiredCheck
- #call — TTY::Option::Pipeline
- #call — TTY::Option::ParamConversion
- #call — TTY::Option::ParamPermitted
- #call — TTY::Option::ParamValidation
- #check_arity — TTY::Option::Parameter
- #check_default — TTY::Option::Parameter
- #check_key_uniqueness! — TTY::Option::Parameters
- #check_long_option_uniqueness! — TTY::Option::Parameters
- #check_permitted — TTY::Option::Parameter
- #check_required — TTY::Option::Parameter
- #check_short_option_uniqueness! — TTY::Option::Parameters
- #check_validation — TTY::Option::Parameter
- #command — TTY::Option::Usage
- #command? — TTY::Option::Usage
- #commands — TTY::Option::Usage
- #consume_arguments — TTY::Option::Parser::Environments
- #consume_arguments — TTY::Option::Parser::Keywords
- #consume_arguments — TTY::Option::Parser::Options
- #contain? — TTY::Option::Converter
- #conversions — TTY::Option::Converter
- #convert — TTY::Option::Parameter
- #convert — TTY::Option::Converter
- #convert? — TTY::Option::Parameter
- #dasherize — TTY::Option::Inflection
- #default — TTY::Option::Parameter
- #default? — TTY::Option::Parameter
- #default_arity — TTY::Option::Parameter
- #default_long — TTY::Option::Parameter::Option
- #default_name — TTY::Option::Parameter
- #default_name — TTY::Option::Parameter::Environment
- #default_name — TTY::Option::Parameter::Option
- #defaults — TTY::Option::Parameter
- #delete — TTY::Option::Parameters
- #delete — TTY::Option::Parser::RequiredCheck
- #delete — TTY::Option::Sections
- #demodulize — TTY::Option::Inflection
- #desc — TTY::Option::Parameter
- #desc — TTY::Option::Usage
- #desc? — TTY::Option::Parameter
- #desc? — TTY::Option::Usage
- #description — TTY::Option::Usage
- #description? — TTY::Option::Usage
- #display? — TTY::Option::Parameter
- #dup — TTY::Option::Parameter
- #dup — TTY::Option::Parameters
- #each — TTY::Option::AggregateErrors
- #each — TTY::Option::Parameters
- #each — TTY::Option::Sections
- #empty? — TTY::Option::Section
- #env — TTY::Option::DSL
- #env_var? — TTY::Option::Parser::ParamTypes
- #environment — TTY::Option::DSL
- #eql? — TTY::Option::Parameter
- #eql? — TTY::Option::Params
- #example — TTY::Option::Usage
- #example? — TTY::Option::Usage
- #examples — TTY::Option::Usage
- #examples? — TTY::Option::Usage
- #failure? — TTY::Option::Result
- #fetch — TTY::Option::Params
- #fetch — TTY::Option::Converter
- #find_index — TTY::Option::Sections
- #flag — TTY::Option::DSL
- #footer — TTY::Option::Usage
- #footer? — TTY::Option::Usage
- #format_argument_usage — TTY::Option::Formatter
- #format_arguments_usage — TTY::Option::Formatter
- #format_default — TTY::Option::Formatter
- #format_description — TTY::Option::Formatter
- #format_examples — TTY::Option::Formatter
- #format_keyword_usage — TTY::Option::Formatter
- #format_keywords_usage — TTY::Option::Formatter
- #format_multiline — TTY::Option::Formatter
- #format_option — TTY::Option::Formatter
- #format_options — TTY::Option::Formatter
- #format_parameter_usage — TTY::Option::Formatter
- #format_section — TTY::Option::Formatter
- #format_section_parameter — TTY::Option::Formatter
- #format_usage — TTY::Option::Formatter
- #hash — TTY::Option::Params
- #header — TTY::Option::Usage
- #header? — TTY::Option::Usage
- #help — TTY::Option::Formatter
- #help — TTY::Option::Interface
- #help_arguments — TTY::Option::Formatter
- #help_banner — TTY::Option::Formatter
- #help_description — TTY::Option::Formatter
- #help_environments — TTY::Option::Formatter
- #help_examples — TTY::Option::Formatter
- #help_footer — TTY::Option::Formatter
- #help_header — TTY::Option::Formatter
- #help_keywords — TTY::Option::Formatter
- #help_options — TTY::Option::Formatter
- #hidden — TTY::Option::Parameter
- #hidden? — TTY::Option::Parameter
- #ignore — TTY::Option::DSL
- #inherited — TTY::Option::Inheritance
- #inspect — TTY::Option::Params
- #keyword — TTY::Option::DSL
- #keyword? — TTY::Option::Parser::ParamTypes
- #kwarg_param_display — TTY::Option::Formatter
- #list_of — TTY::Option::DSL::Conversion
- #long — TTY::Option::Parameter::Option
- #long? — TTY::Option::Parameter::Option
- #long_name — TTY::Option::Parameter::Option
- #map_of — TTY::Option::DSL::Conversion
- #merge — TTY::Option::Params
- #merge! — TTY::Option::Params
- #messages — TTY::Option::AggregateErrors
- #min_arity — TTY::Option::Parameter
- #multi_argument? — TTY::Option::Parameter
- #multiple? — TTY::Option::Parameter
- #name — TTY::Option::Parameter
- #next_argument — TTY::Option::Parser::Arguments
- #next_envvar — TTY::Option::Parser::Environments
- #next_keyword — TTY::Option::Parser::Keywords
- #next_line — TTY::Option::UsageWrapper
- #next_option — TTY::Option::Parser::Options
- #no_command — TTY::Option::Usage
- #no_command? — TTY::Option::Usage
- #one — TTY::Option::DSL::Arity
- #one_or_more — TTY::Option::DSL::Arity
- #opt — TTY::Option::DSL
- #option — TTY::Option::DSL
- #option? — TTY::Option::Parser::ParamTypes
- #optional — TTY::Option::Parameter
- #optional? — TTY::Option::Parameter
- #parameters — TTY::Option::DSL
- #params — TTY::Option::Interface
- #parse — TTY::Option::Parser
- #parse — TTY::Option::Parser::Arguments
- #parse — TTY::Option::Parser::Environments
- #parse — TTY::Option::Parser::Keywords
- #parse — TTY::Option::Parser::Options
- #parse — TTY::Option::Interface
- #permit — TTY::Option::Parameter
- #permit? — TTY::Option::Parameter
- #pluralize — TTY::Option::InvalidArity
- #process_double_option — TTY::Option::Parser::Options
- #process_exact_arity — TTY::Option::Parser::Arguments
- #process_infinite_arity — TTY::Option::Parser::Arguments
- #process_single_option — TTY::Option::Parser::Options
- #program — TTY::Option::Usage
- #raise_unsupported_error — TTY::Option::Converter
- #replace — TTY::Option::Sections
- #required — TTY::Option::Parameter
- #required? — TTY::Option::Parameter
- #required? — TTY::Option::Parameter::Argument
- #required? — TTY::Option::Parameter::Keyword
- #setup_opts — TTY::Option::Parser::Options
- #short — TTY::Option::Parameter::Option
- #short? — TTY::Option::Parameter::Option
- #short_name — TTY::Option::Parameter::Option
- #skip — TTY::Option::DSL
- #success? — TTY::Option::Result
- #summary — TTY::Option::AggregateErrors
- #to_a — TTY::Option::Section
- #to_h — TTY::Option::Parameter
- #to_h — TTY::Option::Params
- #to_h — TTY::Option::Usage
- #to_s — TTY::Option::Params
- #to_s — TTY::Option::Section
- #to_sym — TTY::Option::Parameter
- #two — TTY::Option::DSL::Arity
- #two_or_more — TTY::Option::DSL::Arity
- #underscore — TTY::Option::Inflection
- #usage — TTY::Option::DSL
- #valid? — TTY::Option::Params
- #validate — TTY::Option::Parameter
- #validate? — TTY::Option::Parameter
- #wrap — TTY::Option::UsageWrapper
- #zero_or_more — TTY::Option::DSL::Arity