Puppet Function: flatten

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

Summary

This function flattens any deeply nested arrays and returns a single flat array as a result.

Overview

flatten() ⇒ Any

> *Note:* *Deprecated* from Puppet 5.5.0, this function has been replaced with a built-in [`flatten`](puppet.com/docs/puppet/latest/function.html#flatten) function.

Examples:

Example usage


flatten(['a', ['b', ['c']]])` returns: `['a','b','c']

Returns:

  • (Any) —

    convert nested arrays into a single flat array



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
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/flatten.rb', line 7

newfunction(:flatten, type: :rvalue, doc: <<-DOC
  @summary
    This function flattens any deeply nested arrays and returns a single flat array
    as a result.

  @return
    convert nested arrays into a single flat array

  @example Example usage

    flatten(['a', ['b', ['c']]])` returns: `['a','b','c']

  > **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a
  built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function.
DOC
) do |arguments|
  raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1

  array = arguments[0]

  unless array.is_a?(Array)
    raise(Puppet::ParseError, 'flatten(): Requires array to work with')
  end

  result = array.flatten

  return result
end