# class Prism::ArrayNode

Represents an array literal. This can be a regular array using brackets or a special array using % like %w or %i.

    [1, 2, 3]
    ^^^^^^^^^

### Attributes

closing_loc[R]

attr_reader `closing_loc`: `Location`?

elements[R]

attr_reader elements: Array

opening_loc[R]

attr_reader `opening_loc`: `Location`?

### Public Class Methods

new(flags, elements, opening_loc, closing_loc, location) click to toggle source

def initialize: (flags: `Integer`, elements: Array, `opening_loc`: `Location`?, `closing_loc`: `Location`?, location: `Location`) -> void

    # File lib/prism/node.rb, line 585
    def initialize(flags, elements, opening_loc, closing_loc, location)
      @flags = flags
      @elements = elements
      @opening_loc = opening_loc
      @closing_loc = closing_loc
      @location = location
    end

type() click to toggle source

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 lib/prism/node.rb, line 682
    def self.type
      :array_node
    end

### Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: `Visitor`) -> void

    # File lib/prism/node.rb, line 594
    def accept(visitor)
      visitor.visit_array_node(self)
    end

child_nodes() click to toggle source

def `child_nodes`: () -> Array[nil | Node]

    # File lib/prism/node.rb, line 599
    def child_nodes
      [*elements]
    end

Also aliased as: deconstruct
closing() click to toggle source

def closing: () -> `String`?

    # File lib/prism/node.rb, line 643
    def closing
      closing_loc&.slice
    end

comment_targets() click to toggle source

def `comment_targets`: () -> Array[Node | Location]

    # File lib/prism/node.rb, line 609
    def comment_targets
      [*elements, *opening_loc, *closing_loc]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File lib/prism/node.rb, line 604
    def compact_child_nodes
      [*elements]
    end

contains_splat?() click to toggle source

def contains_splat?: () -> bool

    # File lib/prism/node.rb, line 633
    def contains_splat?
      flags.anybits?(ArrayNodeFlags::CONTAINS_SPLAT)
    end

copy(**params) click to toggle source

def copy: (**params) -> `ArrayNode`

    # File lib/prism/node.rb, line 614
    def copy(**params)
      ArrayNode.new(
        params.fetch(:flags) { flags },
        params.fetch(:elements) { elements },
        params.fetch(:opening_loc) { opening_loc },
        params.fetch(:closing_loc) { closing_loc },
        params.fetch(:location) { location },
      )
    end

deconstruct()

def deconstruct: () -> Array[nil | Node]

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

def `deconstruct_keys`: (keys: Array) -> Hash[Symbol, nil | `Node` | Array | `String` | `Token` | Array | Location]

    # File lib/prism/node.rb, line 628
    def deconstruct_keys(keys)
      { flags: flags, elements: elements, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
    end

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> `String`

    # File lib/prism/node.rb, line 648
    def inspect(inspector = NodeInspector.new)
      inspector << inspector.header(self)
      flags = [("contains_splat" if contains_splat?)].compact
      inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
      inspector << "├── elements: #{inspector.list("#{inspector.prefix}│   ", elements)}"
      inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
      inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
      inspector.to_str
    end

opening() click to toggle source

def opening: () -> `String`?

    # File lib/prism/node.rb, line 638
    def opening
      opening_loc&.slice
    end

type() click to toggle source

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`

    # File lib/prism/node.rb, line 672
    def type
      :array_node
    end