Puppet Function: keys

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

Overview

keys() ⇒ Any

Returns the keys of a hash as an array.

Returns:

  • (Any) 


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

newfunction(:keys, :type => :rvalue, :doc => <<-EOS
Returns the keys of a hash as an array.
  EOS
) do |arguments|

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

  hash = arguments[0]

  unless hash.is_a?(Hash)
    raise(Puppet::ParseError, 'keys(): Requires hash to work with')
  end

  result = hash.keys

  return result
end