summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorDavid Schmitt <david.schmitt@puppetlabs.com>2015-09-14 18:26:25 +0100
committerDavid Schmitt <david.schmitt@puppetlabs.com>2015-09-14 18:26:25 +0100
commit00c881d0dabe77fd2401beb0d39c7386b50bb791 (patch)
tree9209c80caf9d1a51d18648b0b65721791e0e92a5 /README.markdown
parent2a7a93ffb49b2ae63d4fd09982fd8c382c1f4b5a (diff)
downloadpuppet-stdlib-00c881d0dabe77fd2401beb0d39c7386b50bb791.tar.gz
puppet-stdlib-00c881d0dabe77fd2401beb0d39c7386b50bb791.tar.bz2
(MODULES-2516) Adds an is_a() function
The data type system is very hard to understand. Many people don't understand why type_of([1,2,3]) == Array will fail, but type_of([1,2,3]) <= Array passes. This does a simpler validation that doesn't rely on explicit data types. Instead, use $foo = [1,2,3] if $foo.is_a(Array) { notify { 'This is an array': } } This is based on code by Ben Ford <ben.ford@puppetlabs.com>. * Added acceptance tests * Added dispatch * Improved unit tests * Added docs to README
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index f95d37d..aeacfdc 100644
--- a/README.markdown
+++ b/README.markdown
@@ -403,6 +403,29 @@ Converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns
Returns an array an intersection of two. For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"]. *Type*: rvalue.
+#### `is_a`
+
+Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks.
+
+ ~~~
+ foo = 3
+ $bar = [1,2,3]
+ $baz = 'A string!'
+
+ if $foo.is_a(Integer) {
+ notify { 'foo!': }
+ }
+ if $bar.is_a(Array) {
+ notify { 'bar!': }
+ }
+ if $baz.is_a(String) {
+ notify { 'baz!': }
+ }
+ ~~~
+
+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.
+
#### `is_array`
Returns 'true' if the variable passed to this function is an array. *Type*: rvalue.