Puppet Function: is_function_available

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

Overview

is_function_available()Any

This function accepts a string as an argument, determines whether the Puppet runtime has access to a function by that name. It returns a true if the function exists, false if not.

Returns:

  • (Any)


5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# File 'modules/stdlib/lib/puppet/parser/functions/is_function_available.rb', line 5

newfunction(:is_function_available, :type => :rvalue, :doc => <<-DOC
  This function accepts a string as an argument, determines whether the
  Puppet runtime has access to a function by that name.  It returns a
  true if the function exists, false if not.
  DOC
           ) do |arguments|

  if arguments.size != 1
    raise(Puppet::ParseError, "is_function_available?(): Wrong number of arguments given #{arguments.size} for 1")
  end

  # Only allow String types
  return false unless arguments[0].is_a?(String)

  function = Puppet::Parser::Functions.function(arguments[0].to_sym)
  function.is_a?(String) && !function.empty?
end