Puppet Function: has_key

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

Overview

has_key() ⇒ Any

Determine if a hash has a certain key value.

Example:

$my_hash = {'key_one' => 'value_one'}
if has_key($my_hash, 'key_two') {
  notice('we will not reach here')
}
if has_key($my_hash, 'key_one') {
  notice('this will be printed')
}

Returns:

  • (Any) 


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

newfunction(:has_key, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args|
  Determine if a hash has a certain key value.

  Example:

      $my_hash = {'key_one' => 'value_one'}
      if has_key($my_hash, 'key_two') {
        notice('we will not reach here')
      }
      if has_key($my_hash, 'key_one') {
        notice('this will be printed')
      }

  ENDHEREDOC

  unless args.length == 2
    raise Puppet::ParseError, ("has_key(): wrong number of arguments (#{args.length}; must be 2)")
  end
  unless args[0].is_a?(Hash)
    raise Puppet::ParseError, "has_key(): expects the first argument to be a hash, got #{args[0].inspect} which is of type #{args[0].class}"
  end
  args[0].has_key?(args[1])

end