Option

GitHub

Block context for nested configuration options.

Used inside option :name, type: :hash do ... end blocks in Adapter::Base and Export::Base subclasses.

Example: instance_eval style

option :pagination, type: :hash do
  option :strategy, type: :symbol, default: :offset
  option :default_size, type: :integer, default: 20
end

Example: yield style

option :pagination, type: :hash do |option|
  option.option :strategy, type: :symbol, default: :offset
  option.option :default_size, type: :integer, default: 20
end

Instance Methods

#option

#option(name, default: nil, enum: nil, type:, &block)

GitHub

Defines a nested option.

Parameters

Name	Type	Default	Description
name	Symbol		The option name.
default	Object, nil	nil	The default value.
enum	Array, nil	nil	The allowed values.
type	Symbol<:boolean, :hash, :integer, :string, :symbol>		The option type.

Returns

void

Yields Option

Example: instance_eval style

option :pagination, type: :hash do
  option :strategy, type: :symbol, default: :offset
  option :default_size, type: :integer, default: 20
end

Example: yield style

option :pagination, type: :hash do |option|
  option.option :strategy, type: :symbol, default: :offset
  option.option :default_size, type: :integer, default: 20
end

---