summaryrefslogtreecommitdiff
path: root/lib/puppet/functions/type_of.rb
diff options
context:
space:
mode:
authorHunter Haugen <hunter@puppetlabs.com>2014-12-15 16:11:10 -0800
committerHunter Haugen <hunter@puppetlabs.com>2015-01-07 16:40:06 -0800
commit7c8ae311cade65e84df1054779a039ff906e630c (patch)
treed1d0bec00d7b74f433d72c292bee0f97ac0f3464 /lib/puppet/functions/type_of.rb
parent4700f16e8273b3d4a3b1e22b09c44d7ac9f74f3e (diff)
(MODULES-1473) Deprecate type() function for new parser
The `type()` function will cease to work on the new parser because 'type' is a reserved keyword. The `type3x()` function may be used to continue similar functionality, but will be deprecated in favor of the built-in typing system. The `type_of()` function has been included to introspect types in the new parser.
Diffstat (limited to 'lib/puppet/functions/type_of.rb')
-rw-r--r--lib/puppet/functions/type_of.rb17
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/puppet/functions/type_of.rb b/lib/puppet/functions/type_of.rb
new file mode 100644
index 0000000..02cdd4d
--- /dev/null
+++ b/lib/puppet/functions/type_of.rb
@@ -0,0 +1,17 @@
+# Returns the type when passed a value.
+#
+# @example how to compare values' types
+# # compare the types of two values
+# if type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") }
+# @example how to compare against an abstract type
+# unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") }
+# unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") }
+#
+# See the documentation for "The Puppet Type System" for more information about types.
+# See the `assert_type()` function for flexible ways to assert the type of a value.
+#
+Puppet::Functions.create_function(:type_of) do
+ def type_of(value)
+ Puppet::Pops::Types::TypeCalculator.infer_set(value)
+ end
+end