Puppet Function: is_array

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

Summary

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

Overview

is_array() ⇒ Boolean

> *Note: Deprecated Will be removed in a future version of stdlib. See [‘validate_legacy`](#validate_legacy).

Returns:

  • (Boolean) —

    Returns ‘true` or `false`



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/puppet/parser/functions/is_array.rb', line 7

newfunction(:is_array, type: :rvalue, doc: <<-DOC
  @summary
    **Deprecated:** Returns true if the variable passed to this function is an array.

  @return [Boolean]
    Returns `true` or `false`

  > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
  [`validate_legacy`](#validate_legacy).
  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