# delete_at.rb
#
module Puppet::Parser::Functions
- newfunction(:delete_at, :type => :rvalue, :doc => <<-DOC
- Deletes a determined indexed value from an array.
+ newfunction(:delete_at, :type => :rvalue, :doc => <<-DOC) do |arguments|
+ @summary
+ Deletes a determined indexed value from an array.
- *Examples:*
+ For example
+ ```delete_at(['a','b','c'], 1)```
- delete_at(['a','b','c'], 1)
+ Would return: `['a','c']`
- Would return: ['a','c']
+ > *Note:*
+ Since Puppet 4 this can be done in general with the built-in
+ [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function:
- Note that since Puppet 4 this can be done in general with the filter function:
-
- ['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }
+ ```['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }```
Or if a delete is wanted from the beginning or end of the array, by using the slice operator [ ]:
+ ```
+ $array[0, -1] # the same as all the values
+ $array[2, -1] # all but the first 2 elements
+ $array[0, -3] # all but the last 2 elements
+ $array[1, -2] # all but the first and last element
+ ```
+
+ @return [Array] The given array, now missing the target value
- $array[0, -1] # the same as all the values
- $array[2, -1] # all but the first 2 elements
- $array[0, -3] # all but the last 2 elements
- $array[1, -2] # all but the first and last element
DOC
- ) do |arguments|
raise(Puppet::ParseError, "delete_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2