Puppet Function: is_array

Defined in:
modules/stdlib/lib/puppet/parser/functions/is_array.rb
Function type:
Ruby 3.x API

Overview

is_array()Any

Returns true if the variable passed to this function is an array.

Returns:

  • (Any)


5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# File 'modules/stdlib/lib/puppet/parser/functions/is_array.rb', line 5

newfunction(:is_array, :type => :rvalue, :doc => <<-DOC
  Returns true if the variable passed to this function is an array.
  DOC
           ) do |arguments|

  function_deprecation([:is_array, 'This method is deprecated, please use the stdlib validate_legacy function,
                         with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.'])

  raise(Puppet::ParseError, "is_array(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?

  type = arguments[0]

  result = type.is_a?(Array)

  return result
end