Puppet Function: is_bool

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

Overview

is_bool() ⇒ Any

Returns true if the variable passed to this function is a boolean.

Returns:

  • (Any) 


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

newfunction(:is_bool, :type => :rvalue, :doc => <<-EOS
Returns true if the variable passed to this function is a boolean.
  EOS
) do |arguments|

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

  raise(Puppet::ParseError, "is_bool(): Wrong number of arguments " +
    "given (#{arguments.size} for 1)") if arguments.size != 1

  type = arguments[0]

  result = type.is_a?(TrueClass) || type.is_a?(FalseClass)

  return result
end