Preview Ruby 4.1 is a preview. It can change before the final release. Switch to Ruby 4.0 →

instance method

OptionParser#on

(*::String params) ?{ (*untyped) -> untyped } -> self

(::String params, ::Class | ::Array[::String] | ::Hash[::Symbol, untyped] | ::Regexp obj, ?::String desc) ?{ (*untyped) -> untyped } -> self

(::String short_params, ::String long_params, ::Class | ::Array[::String] | ::Hash[::Symbol, untyped] | ::Regexp obj, ?::String desc) ?{ (*untyped) -> untyped } -> self

(*::String params, ::Proc | ::Method handler) -> self

(::String params, ::Class | ::Array[::String] | ::Hash[::Symbol, untyped] | ::Regexp obj, ?::String desc, ::Proc | ::Method handler) -> self

(::String short_params, ::String long_params, ::Class | ::Array[::String] | ::Hash[::Symbol, untyped] | ::Regexp obj, ?::String desc, ::Proc | ::Method handler) -> self

on(*params, &block)

lib/optparse.rb View on GitHub ↗

# File tmp/rubies/ruby-4.1.0-preview1/lib/optparse.rb, line 1641
def on(*opts, &block)
  define(*opts, &block)
  self
end

Creates an option from the given parameters params. See Parameters for New Options.

The block, if given, is the handler for the created option. When the option is encountered during command-line parsing, the block is called with the argument given for the option, if any. See Option Handlers.

See also #new #on_head #make_switch #on_tail also in 4.0 · 3.4 · 3.3 · 3.2 · 3.1 · 3.0

‹ prev#new next ›#on_head