module OptionParser::Arguable

Extends command line arguments array (ARGV) to parse itself.

Public Instance Methods

(*String args) → Hash[String, untyped]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/optparse/0/optparse.rbs, line 1162
def getopts: (*String args) -> Hash[String, untyped]

Substitution of getopts is possible as follows. Also see OptionParser#getopts.

def getopts(*args)
  ($OPT = ARGV.getopts(*args)).each do |opt, val|
    eval "$OPT_#{opt.gsub(/[^A-Za-z0-9_]/, '_')} = val"
  end
rescue OptionParser::ParseError
end

options

() → OptionParser
[T] () { (OptionParser) → T } → T?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/optparse/0/optparse.rbs, line 1174
def options: () -> OptionParser
             | [T] () { (OptionParser) -> T } -> T?

Actual OptionParser object, automatically created if nonexistent.

If called with a block, yields the OptionParser object and returns the result of the block. If an OptionParser::ParseError exception occurs in the block, it is rescued, a error message printed to STDERR and nil returned.

options=

(OptionParser? opt) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/optparse/0/optparse.rbs, line 1186
def options=: (OptionParser? opt) -> untyped

Sets OptionParser object, when opt is false or nil, methods OptionParser::Arguable#options and OptionParser::Arguable#options= are undefined. Thus, there is no ways to access the OptionParser object via the receiver object.

order!

() ?{ (String) → void } → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/optparse/0/optparse.rbs, line 1195
def order!: () ?{ (String) -> void } -> Array[String]

Parses self destructively in order and returns self containing the rest arguments left unparsed.

parse!

() → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/optparse/0/optparse.rbs, line 1204
def parse!: () -> Array[String]

Parses self destructively and returns self containing the rest arguments left unparsed.

permute!

() → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/optparse/0/optparse.rbs, line 1213
def permute!: () -> Array[String]

Parses self destructively in permutation mode and returns self containing the rest arguments left unparsed.