module TTY::Option::Interface

Public Instance Methods

help(**config, &block) click to toggle source

Provide a formatted help usage for the configured parameters

@return [String]

@api public

# File lib/tty/option.rb, line 63
def help(**config, &block)
  Formatter.help(self.class.parameters, self.class.usage, **config, &block)
end
params() click to toggle source

The parsed parameters

@api public

# File lib/tty/option.rb, line 37
def params
  @__params ||= Params.create
end
parse(argv = ARGV, env = ENV, check_invalid_params: true, raise_on_parse_error: false) click to toggle source

Parse command line arguments

@param [Array<String>] argv

the command line arguments

@param [Hash] env

the hash of environment variables

@api public

# File lib/tty/option.rb, line 49
def parse(argv = ARGV, env = ENV, check_invalid_params: true,
          raise_on_parse_error: false)
  parser = Parser.new(self.class.parameters,
                      check_invalid_params: check_invalid_params,
                      raise_on_parse_error: raise_on_parse_error)
  @__params = Params.create(*parser.parse(argv, env))
  self
end