#
module Puppet::Parser::Functions
newfunction(:reject, :type => :rvalue, :doc => <<-DOC) do |args|
- This function searches through an array and rejects all elements that match
- the provided regular expression.
+ @summary
+ This function searches through an array and rejects all elements that match
+ the provided regular expression.
- *Examples:*
+ @return
+ an array containing all the elements which doesn'' match the provided regular expression
- reject(['aaa','bbb','ccc','aaaddd'], 'aaa')
+ @example **Usage**
- Would return:
+ reject(['aaa','bbb','ccc','aaaddd'], 'aaa')
- ['bbb','ccc']
+ Would return: ['bbb','ccc']
- Note that since Puppet 4.0.0 the same is in general done with the filter function. Here is the
- equivalence of the reject() function:
-
- ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ }
+ > *Note:*
+ Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function:
+ ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ }
DOC
if args.size != 2