Represents an optional parameter to a method, block, or lambda definition.
def a(b = 1)
^^^^^
end
attr_reader operator_loc: Location
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12962
def initialize(name, name_loc, operator_loc, value, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13049
def self.type
:optional_parameter_node
end
Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.
def self.type: () -> Symbol
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12971
def accept(visitor)
visitor.visit_optional_parameter_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12976
def child_nodes
[value]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12986
def comment_targets
[name_loc, operator_loc, value]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12981
def compact_child_nodes
[value]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12991
def copy(**params)
OptionalParameterNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
def copy: (**params) -> OptionalParameterNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13005
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13015
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
def inspect(inspector: NodeInspector) -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13010
def operator
operator_loc.slice
end
def operator: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13039
def type
:optional_parameter_node
end
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.
Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.
def type: () -> Symbol