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()Boolean

This function accepts a string as an argument.

> *Note: *Deprecated* Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).

Returns:

  • (Boolean)

    Returns `true` or `false`



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

newfunction(:is_function_available, :type => :rvalue, :doc => <<-DOC
  @summary
    **Deprecated:** Determines whether the Puppet runtime has access to a function by that name.

  This function accepts a string as an argument.

  @return [Boolean]
    Returns `true` or `false`

  > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
  [`validate_legacy`](#validate_legacy).
  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