Puppet Function: is_string

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

Overview

is_string()Boolean

> *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
29
30
31
32
# File 'modules/stdlib/lib/puppet/parser/functions/is_string.rb', line 5

newfunction(:is_string, :type => :rvalue, :doc => <<-DOC
  @summary
    **Deprecated:** Returns true if the variable passed to this function is a string.

  @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|

  function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function,
                        with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.'])

  raise(Puppet::ParseError, "is_string(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?

  type = arguments[0]

  # when called through the v4 API shim, undef gets translated to nil
  result = type.is_a?(String) || type.nil?

  if result && (type == type.to_f.to_s || type == type.to_i.to_s)
    return false
  end

  return result
end