Puppet Function: keys

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

Overview

keys()Array

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

Returns:

  • (Array)

    An array containing each of the hashes key values.



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/keys.rb', line 5

newfunction(:keys, :type => :rvalue, :doc => <<-DOC
  @summary
    **Deprecated:** Returns the keys of a hash as an array.

  @return [Array]
    An array containing each of the hashes key values.

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

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

  hash = arguments[0]

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

  result = hash.keys

  return result
end