Puppet Function: empty

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

Overview

empty()Any

> Note: *Deprecated* from Puppet 5.5.0, the built-in [`empty`](puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead.

Returns:

  • (Any)

    Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value.



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

newfunction(:empty, :type => :rvalue, :doc => <<-DOC
  @summary
    **Deprecated:** Returns true if the variable is empty.

  @return
    Returns `true` if the argument is an array or hash that contains no elements,
    or an empty string. Returns `false` when the argument is a numerical value.

  > *Note*: **Deprecated** from Puppet 5.5.0, the built-in
  [`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead.
DOC
           ) do |arguments|

  raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
  value = arguments[0]

  unless value.is_a?(Array) || value.is_a?(Hash) || value.is_a?(String) || value.is_a?(Numeric)
    raise(Puppet::ParseError, 'empty(): Requires either array, hash, string or integer to work with')
  end

  return false if value.is_a?(Numeric)
  result = value.empty?
  return result
end