Puppet Function: values

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

Summary

When given a hash this function will return the values of that hash.

Overview

values() ⇒ Any

> Note: From Puppet 5.5.0, the compatible function with the same name in Puppet core will be used instead of this function.

Examples:

Usage

$hash = {
  'a' => 1,
  'b' => 2,
  'c' => 3,
}
values($hash)

This example would return: ```[1,2,3]```

Returns:

  • (Any) —

    array of 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
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/puppet/parser/functions/values.rb', line 5

newfunction(:values, :type => :rvalue, :doc => <<-DOC
  @summary
    When given a hash this function will return the values of that hash.

  @return
    array of values

  @example **Usage**
    $hash = {
      'a' => 1,
      'b' => 2,
      'c' => 3,
    }
    values($hash)

    This example would return: ```[1,2,3]```

  > *Note:*
  From Puppet 5.5.0, the compatible function with the same name in Puppet core
  will be used instead of this function.

DOC
           ) do |arguments|

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

  hash = arguments[0]

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

  result = hash.values

  return result
end