summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSpencer Krum <nibz@spencerkrum.com>2015-03-28 20:27:06 -0700
committerSpencer Krum <nibz@spencerkrum.com>2015-03-28 20:34:42 -0700
commitc297bd80e38c73618c0c706783386fef63bf0682 (patch)
treec6fb12a2bbaa1b3c46c02c10decf01f92b785c1b
parent2762bb6c930a3547aaef339fd8f649af349385c2 (diff)
Make each function a link in the readme
Using a ####, github will create a link. This makes it so I can link someone directly to the function I want to show them.
-rw-r--r--README.markdown388
1 files changed, 291 insertions, 97 deletions
diff --git a/README.markdown b/README.markdown
index 9c6a54b..293a81a 100644
--- a/README.markdown
+++ b/README.markdown
@@ -99,44 +99,68 @@ If you want to use a standardized set of run stages for Puppet, `include stdlib`
### Functions
-* `abs`: Returns the absolute value of a number; for example, '-34.56' becomes '34.56'. Takes a single integer and float value as an argument. *Type*: rvalue
+#### `abs`
-* `any2array`: This converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. *Type*: rvalue
+Returns the absolute value of a number; for example, '-34.56' becomes '34.56'. Takes a single integer and float value as an argument. *Type*: rvalue
-* `base64`: Converts a string to and from base64 encoding.
+#### `any2array`
+
+This converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. *Type*: rvalue
+
+#### `base64`
+
+Converts a string to and from base64 encoding.
Requires an action ('encode', 'decode') and either a plain or base64-encoded
string. *Type*: rvalue
-* `basename`: Returns the `basename` of a path (optionally stripping an extension). For example:
+#### `basename`
+
+Returns the `basename` of a path (optionally stripping an extension). For example:
* ('/path/to/a/file.ext') returns 'file.ext'
* ('relative/path/file.ext') returns 'file.ext'
* ('/path/to/a/file.ext', '.ext') returns 'file'
*Type*: rvalue
-* `bool2num`: Converts a boolean to a number. Converts values:
+#### `bool2num`
+
+Converts a boolean to a number. Converts values:
* 'false', 'f', '0', 'n', and 'no' to 0.
* 'true', 't', '1', 'y', and 'yes' to 1.
Requires a single boolean or string as an input. *Type*: rvalue
-* `capitalize`: Capitalizes the first letter of a string or array of strings.
+#### `capitalize`
+
+Capitalizes the first letter of a string or array of strings.
Requires either a single string or an array as an input. *Type*: rvalue
-* `ceiling`: Returns the smallest integer greater than or equal to the argument.
+#### `ceiling`
+
+Returns the smallest integer greater than or equal to the argument.
Takes a single numeric value as an argument. *Type*: rvalue
-* `chomp`: Removes the record separator from the end of a string or an array of
+#### `chomp`
+
+Removes the record separator from the end of a string or an array of
strings; for example, 'hello\n' becomes 'hello'. Requires a single string or array as an input. *Type*: rvalue
-* `chop`: Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. If you want to merely remove record separators, then you should use the `chomp` function. Requires a string or an array of strings as input. *Type*: rvalue
+#### `chop`
+
+Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. If you want to merely remove record separators, then you should use the `chomp` function. Requires a string or an array of strings as input. *Type*: rvalue
+
+#### `concat`
-* `concat`: Appends the contents of multiple arrays onto array 1. For example:
+Appends the contents of multiple arrays onto array 1. For example:
* `concat(['1','2','3'],'4')` results in: ['1','2','3','4'].
* `concat(['1','2','3'],'4',['5','6','7'])` results in: ['1','2','3','4','5','6','7'].
-* `count`: Takes an array as first argument and an optional second argument. Count the number of elements in array that matches second argument. If called with only an array, it counts the number of elements that are **not** nil/undef. *Type*: rvalue
+#### `count`
-* `defined_with_params`: Takes a resource reference and an optional hash of attributes. Returns 'true' if a resource with the specified attributes has already been added to the catalog. Returns 'false' otherwise.
+Takes an array as first argument and an optional second argument. Count the number of elements in array that matches second argument. If called with only an array, it counts the number of elements that are **not** nil/undef. *Type*: rvalue
+
+#### `defined_with_params`
+
+Takes a resource reference and an optional hash of attributes. Returns 'true' if a resource with the specified attributes has already been added to the catalog. Returns 'false' otherwise.
```
user { 'dan':
@@ -150,28 +174,48 @@ strings; for example, 'hello\n' becomes 'hello'. Requires a single string or arr
*Type*: rvalue
-* `delete`: Deletes all instances of a given element from an array, substring from a
+#### `delete`
+
+Deletes all instances of a given element from an array, substring from a
string, or key from a hash. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1} *Type*: rvalue
-* `delete_at`: Deletes a determined indexed value from an array. For example, `delete_at(['a','b','c'], 1)` returns ['a','c']. *Type*: rvalue
+#### `delete_at`
-* `delete_values`: Deletes all instances of a given value from a hash. For example, `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} *Type*: rvalue
+Deletes a determined indexed value from an array. For example, `delete_at(['a','b','c'], 1)` returns ['a','c']. *Type*: rvalue
-* `delete_undef_values`: Deletes all instances of the undef value from an array or hash. For example, `$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})` returns {a => 'A', b => '', d => false}. *Type*: rvalue
+#### `delete_values`
-* `difference`: Returns the difference between two arrays.
+Deletes all instances of a given value from a hash. For example, `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} *Type*: rvalue
+
+#### `delete_undef_values`
+
+Deletes all instances of the undef value from an array or hash. For example, `$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})` returns {a => 'A', b => '', d => false}. *Type*: rvalue
+
+#### `difference`
+
+Returns the difference between two arrays.
The returned array is a copy of the original array, removing any items that
also appear in the second array. For example, `difference(["a","b","c"],["b","c","d"])` returns ["a"].
-* `dirname`: Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'.
+#### `dirname`
+
+Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'.
+
+#### `downcase`
-* `downcase`: Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue
+Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue
-* `empty`: Returns 'true' if the variable is empty. *Type*: rvalue
+#### `empty`
-* `ensure_packages`: Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` function. *Type*: statement
+Returns 'true' if the variable is empty. *Type*: rvalue
-* `ensure_resource`: Takes a resource type, title, and a list of attributes that describe a resource.
+#### `ensure_packages`
+
+Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` function. *Type*: statement
+
+#### `ensure_resource`
+
+Takes a resource type, title, and a list of attributes that describe a resource.
```
user { 'dan':
@@ -191,20 +235,30 @@ also appear in the second array. For example, `difference(["a","b","c"],["b","c"
*Type*: statement
-* `flatten`: This function flattens any deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. *Type*: rvalue
+#### `flatten`
-* `floor`: Returns the largest integer less than or equal to the argument.
+This function flattens any deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. *Type*: rvalue
+
+#### `floor`
+
+Returns the largest integer less than or equal to the argument.
Takes a single numeric value as an argument. *Type*: rvalue
-* `fqdn_rotate`: Rotates an array a random number of times based on a node's fqdn. *Type*: rvalue
+#### `fqdn_rotate`
+
+Rotates an array a random number of times based on a node's fqdn. *Type*: rvalue
-* `get_module_path`: Returns the absolute path of the specified module for the current environment.
+#### `get_module_path`
+
+Returns the absolute path of the specified module for the current environment.
`$module_path = get_module_path('stdlib')`
*Type*: rvalue
-* `getparam`: Takes a resource reference and the name of the parameter and
+#### `getparam`
+
+Takes a resource reference and the name of the parameter and
returns the value of the resource's parameter. For example, the following code returns 'param_value'.
*Example:*
@@ -222,7 +276,9 @@ returns the value of the resource's parameter. For example, the following code r
*Type*: rvalue
-* `getvar`: Lookup a variable in a remote namespace.
+#### `getvar`
+
+Lookup a variable in a remote namespace.
For example:
@@ -241,9 +297,13 @@ returns the value of the resource's parameter. For example, the following code r
*Type*: rvalue
-* `grep`: This function searches through an array and returns any elements that match the provided regular expression. For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. *Type*: rvalue
+#### `grep`
-* `has_interface_with`: Returns boolean based on kind and value:
+This function searches through an array and returns any elements that match the provided regular expression. For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. *Type*: rvalue
+
+#### `has_interface_with`
+
+Returns boolean based on kind and value:
* macaddress
* netmask
* ipaddress
@@ -264,11 +324,17 @@ returns the value of the resource's parameter. For example, the following code r
*Type*: rvalue
-* `has_ip_address`: Returns true if the client has the requested IP address on some interface. This function iterates through the `interfaces` fact and checks the `ipaddress_IFACE` facts, performing a simple string comparison. *Type*: rvalue
+#### `has_ip_address`
+
+Returns true if the client has the requested IP address on some interface. This function iterates through the `interfaces` fact and checks the `ipaddress_IFACE` facts, performing a simple string comparison. *Type*: rvalue
-* `has_ip_network`: Returns true if the client has an IP address within the requested network. This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. *Type*: rvalue
+#### `has_ip_network`
-* `has_key`: Determine if a hash has a certain key value.
+Returns true if the client has an IP address within the requested network. This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. *Type*: rvalue
+
+#### `has_key`
+
+Determine if a hash has a certain key value.
*Example*:
@@ -284,39 +350,73 @@ returns the value of the resource's parameter. For example, the following code r
*Type*: rvalue
-* `hash`: This function converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue
+#### `hash`
+
+This function converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue
+
+#### `intersection`
+
+This function returns an array an intersection of two. For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"].
+
+#### `is_array`
+
+Returns 'true' if the variable passed to this function is an array. *Type*: rvalue
+
+#### `is_bool`
+
+Returns 'true' if the variable passed to this function is a boolean. *Type*: rvalue
+
+#### `is_domain_name`
+
+Returns 'true' if the string passed to this function is a syntactically correct domain name. *Type*: rvalue
+
+#### `is_float`
+
+Returns 'true' if the variable passed to this function is a float. *Type*: rvalue
+
+#### `is_function_available`
+
+This function accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns 'true' if the function exists, 'false' if not. *Type*: rvalue
+
+#### `is_hash`
+
+Returns 'true' if the variable passed to this function is a hash. *Type*: rvalue
+
+#### `is_integer`
-* `intersection`: This function returns an array an intersection of two. For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"].
+Returns 'true' if the variable returned to this string is an integer. *Type*: rvalue
-* `is_array`: Returns 'true' if the variable passed to this function is an array. *Type*: rvalue
+#### `is_ip_address`
-* `is_bool`: Returns 'true' if the variable passed to this function is a boolean. *Type*: rvalue
+Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue
-* `is_domain_name`: Returns 'true' if the string passed to this function is a syntactically correct domain name. *Type*: rvalue
+#### `is_mac_address`
-* `is_float`: Returns 'true' if the variable passed to this function is a float. *Type*: rvalue
+Returns 'true' if the string passed to this function is a valid MAC address. *Type*: rvalue
-* `is_function_available`: This function accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns 'true' if the function exists, 'false' if not. *Type*: rvalue
+#### `is_numeric`
-* `is_hash`: Returns 'true' if the variable passed to this function is a hash. *Type*: rvalue
+Returns 'true' if the variable passed to this function is a number. *Type*: rvalue
-* `is_integer`: Returns 'true' if the variable returned to this string is an integer. *Type*: rvalue
+#### `is_string`
-* `is_ip_address`: Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue
+Returns 'true' if the variable passed to this function is a string. *Type*: rvalue
-* `is_mac_address`: Returns 'true' if the string passed to this function is a valid MAC address. *Type*: rvalue
+#### `join`
-* `is_numeric`: Returns 'true' if the variable passed to this function is a number. *Type*: rvalue
+This function joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". *Type*: rvalue
-* `is_string`: Returns 'true' if the variable passed to this function is a string. *Type*: rvalue
+#### `join_keys_to_values`
-* `join`: This function joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". *Type*: rvalue
+This function joins each key of a hash to that key's corresponding value with a separator. Keys and values are cast to strings. The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>2}, " is ")` results in ["a is 1","b is 2"]. *Type*: rvalue
-* `join_keys_to_values`: This function joins each key of a hash to that key's corresponding value with a separator. Keys and values are cast to strings. The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>2}, " is ")` results in ["a is 1","b is 2"]. *Type*: rvalue
+#### `keys`
-* `keys`: Returns the keys of a hash as an array. *Type*: rvalue
+Returns the keys of a hash as an array. *Type*: rvalue
-* `loadyaml`: Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. For example:
+#### `loadyaml`
+
+Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. For example:
```
$myhash = loadyaml('/etc/puppet/data/myhash.yaml')
@@ -324,13 +424,21 @@ returns the value of the resource's parameter. For example, the following code r
*Type*: rvalue
-* `lstrip`: Strips leading spaces to the left of a string. *Type*: rvalue
+#### `lstrip`
+
+Strips leading spaces to the left of a string. *Type*: rvalue
+
+#### `max`
-* `max`: Returns the highest value of all arguments. Requires at least one argument. *Type*: rvalue
+Returns the highest value of all arguments. Requires at least one argument. *Type*: rvalue
-* `member`: This function determines if a variable is a member of an array. The variable can be either a string, array, or fixnum. For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return 'true', while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return 'false'. *Type*: rvalue
+#### `member`
-* `merge`: Merges two or more hashes together and returns the resulting hash.
+This function determines if a variable is a member of an array. The variable can be either a string, array, or fixnum. For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return 'true', while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return 'false'. *Type*: rvalue
+
+#### `merge`
+
+Merges two or more hashes together and returns the resulting hash.
*Example*:
@@ -344,15 +452,25 @@ returns the value of the resource's parameter. For example, the following code r
When there is a duplicate key, the key in the rightmost hash "wins." *Type*: rvalue
-* `min`: Returns the lowest value of all arguments. Requires at least one argument. *Type*: rvalue
+#### `min`
+
+Returns the lowest value of all arguments. Requires at least one argument. *Type*: rvalue
-* `num2bool`: This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes 'false'. Numbers greater than 0 become 'true'. *Type*: rvalue
+#### `num2bool`
-* `parsejson`: This function accepts JSON as a string and converts into the correct Puppet structure. *Type*: rvalue
+This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes 'false'. Numbers greater than 0 become 'true'. *Type*: rvalue
-* `parseyaml`: This function accepts YAML as a string and converts it into the correct Puppet structure. *Type*: rvalue
+#### `parsejson`
-* `pick`: From a list of values, returns the first value that is not undefined or an empty string. Takes any number of arguments, and raises an error if all values are undefined or empty.
+This function accepts JSON as a string and converts into the correct Puppet structure. *Type*: rvalue
+
+#### `parseyaml`
+
+This function accepts YAML as a string and converts it into the correct Puppet structure. *Type*: rvalue
+
+#### `pick`
+
+From a list of values, returns the first value that is not undefined or an empty string. Takes any number of arguments, and raises an error if all values are undefined or empty.
```
$real_jenkins_version = pick($::jenkins_version, '1.449')
@@ -360,10 +478,14 @@ returns the value of the resource's parameter. For example, the following code r
*Type*: rvalue
-* `prefix`: This function applies a prefix to all elements in an array or to the keys in a hash. For example, `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'], and `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. *Type*: rvalue
+#### `prefix`
+
+This function applies a prefix to all elements in an array or to the keys in a hash. For example, `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'], and `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. *Type*: rvalue
+
+#### `assert_private`
-* `assert_private`: This function sets the current class or definition as private.
+This function sets the current class or definition as private.
Calling the class or definition from outside the current module will fail. For example, `assert_private()` called in class `foo::bar` outputs the following message if class is called from outside module `foo`:
```
@@ -378,7 +500,9 @@ Calling the class or definition from outside the current module will fail. For e
*Type*: statement
-* `range`: When given range in the form of '(start, stop)', `range` extrapolates a range as an array. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9].
+#### `range`
+
+When given range in the form of '(start, stop)', `range` extrapolates a range as an array. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9].
Non-integer strings are accepted; `range("a", "c")` returns ["a","b","c"], and `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"].
@@ -386,26 +510,46 @@ Calling the class or definition from outside the current module will fail. For e
*Type*: rvalue
-* `reject`: This function searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue
+#### `reject`
+
+This function searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue
+
+#### `reverse`
+
+Reverses the order of a string or array. *Type*: rvalue
+
+#### `rstrip`
+
+Strips leading spaces to the right of the string.*Type*: rvalue
-* `reverse`: Reverses the order of a string or array. *Type*: rvalue
+#### `shuffle`
-* `rstrip`: Strips leading spaces to the right of the string.*Type*: rvalue
+Randomizes the order of a string or array elements. *Type*: rvalue
-* `shuffle`: Randomizes the order of a string or array elements. *Type*: rvalue
+#### `size`
-* `size`: Returns the number of elements in a string or array. *Type*: rvalue
+Returns the number of elements in a string or array. *Type*: rvalue
-* `sort`: Sorts strings and arrays lexically. *Type*: rvalue
+#### `sort`
-* `squeeze`: Returns a new string where runs of the same character that occur in this set are replaced by a single character. *Type*: rvalue
+Sorts strings and arrays lexically. *Type*: rvalue
-* `str2bool`: This converts a string to a boolean. This attempts to convert strings that contain values such as '1', 't', 'y', and 'yes' to 'true' and strings that contain values such as '0', 'f', 'n', and 'no' to 'false'. *Type*: rvalue
+#### `squeeze`
-* `str2saltedsha512`: This converts a string to a salted-SHA512 password hash, used for OS X versions >= 10.7. Given any string, this function returns a hex version of a salted-SHA512 password hash, which can be inserted into your Puppet
+Returns a new string where runs of the same character that occur in this set are replaced by a single character. *Type*: rvalue
+
+#### `str2bool`
+
+This converts a string to a boolean. This attempts to convert strings that contain values such as '1', 't', 'y', and 'yes' to 'true' and strings that contain values such as '0', 'f', 'n', and 'no' to 'false'. *Type*: rvalue
+
+#### `str2saltedsha512`
+
+This converts a string to a salted-SHA512 password hash, used for OS X versions >= 10.7. Given any string, this function returns a hex version of a salted-SHA512 password hash, which can be inserted into your Puppet
manifests as a valid password attribute. *Type*: rvalue
-* `strftime`: This function returns formatted time. For example, `strftime("%s")` returns the time since epoch, and `strftime("%Y=%m-%d")` returns the date. *Type*: rvalue
+#### `strftime`
+
+This function returns formatted time. For example, `strftime("%s")` returns the time since epoch, and `strftime("%Y=%m-%d")` returns the date. *Type*: rvalue
*Format:*
@@ -455,35 +599,59 @@ manifests as a valid password attribute. *Type*: rvalue
* `%Z`: Time zone name
* `%%`: Literal '%' character
-* `strip`: This function removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". *Type*: rvalue
+#### `strip`
+
+This function removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". *Type*: rvalue
-* `suffix`: This function applies a suffix to all elements in an array. For example, `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. *Type*: rvalue
+#### `suffix`
-* `swapcase`: This function swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". *Type*: rvalue
+This function applies a suffix to all elements in an array. For example, `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. *Type*: rvalue
-* `time`: This function returns the current time since epoch as an integer. For example, `time()` returns something like '1311972653'. *Type*: rvalue
+#### `swapcase`
-* `to_bytes`: Converts the argument into bytes, for example 4 kB becomes 4096.
+This function swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". *Type*: rvalue
+
+#### `time`
+
+This function returns the current time since epoch as an integer. For example, `time()` returns something like '1311972653'. *Type*: rvalue
+
+#### `to_bytes`
+
+Converts the argument into bytes, for example 4 kB becomes 4096.
Takes a single string value as an argument. *Type*: rvalue
-* `type3x`: Returns a string description of the type when passed a value. Type can be a string, array, hash, float, integer, or boolean. This function will be removed when puppet 3 support is dropped and the new type system may be used. *Type*: rvalue
+#### `type3x`
+
+Returns a string description of the type when passed a value. Type can be a string, array, hash, float, integer, or boolean. This function will be removed when puppet 3 support is dropped and the new type system may be used. *Type*: rvalue
+
+#### `type_of`
-* `type_of`: Returns the literal type when passed a value. Requires the new
+Returns the literal type when passed a value. Requires the new
parser. Useful for comparison of types with `<=` such as in `if
type_of($some_value) <= Array[String] { ... }` (which is equivalent to `if
$some_value =~ Array[String] { ... }`) *Type*: rvalue
-* `union`: This function returns a union of two arrays. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"].
+#### `union`
-* `unique`: This function removes duplicates from strings and arrays. For example, `unique("aabbcc")` returns 'abc'.
+This function returns a union of two arrays. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"].
+
+#### `unique`
+
+This function removes duplicates from strings and arrays. For example, `unique("aabbcc")` returns 'abc'.
You can also use this with arrays. For example, `unique(["a","a","b","b","c","c"])` returns ["a","b","c"]. *Type*: rvalue
-* `upcase`: Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase("abcd")` returns 'ABCD'. *Type*: rvalue
+#### `upcase`
+
+Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase("abcd")` returns 'ABCD'. *Type*: rvalue
-* `uriescape`: Urlencodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue
+#### `uriescape`
-* `validate_absolute_path`: Validate the string represents an absolute path in the filesystem. This function works for Windows and Unix style paths.
+Urlencodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue
+
+#### `validate_absolute_path`
+
+Validate the string represents an absolute path in the filesystem. This function works for Windows and Unix style paths.
The following values will pass:
@@ -512,7 +680,9 @@ You can also use this with arrays. For example, `unique(["a","a","b","b","c","c"
*Type*: statement
-* `validate_array`: Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check.
+#### `validate_array`
+
+Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check.
The following values will pass:
@@ -532,7 +702,9 @@ You can also use this with arrays. For example, `unique(["a","a","b","b","c","c"
*Type*: statement
-* `validate_augeas`: Performs validation of a string using an Augeas lens.
+#### `validate_augeas`
+
+Performs validation of a string using an Augeas lens.
The first argument of this function should be the string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation aborts with a parse error.
A third optional argument lists paths which should **not** be found in the file. The `$file` variable points to the location of the temporary file being tested in the Augeas tree.
@@ -557,7 +729,9 @@ The first argument of this function should be the string to test, and the second
*Type*: statement
-* `validate_bool`: Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check.
+#### `validate_bool`
+
+Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check.
The following values will pass:
@@ -578,7 +752,9 @@ The first argument of this function should be the string to test, and the second
*Type*: statement
-* `validate_cmd`: Performs validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end of the command if no % placeholder given). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error.
+#### `validate_cmd`
+
+Performs validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end of the command if no % placeholder given). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error.
If a third argument is specified, this will be the error message raised and seen by the user.
@@ -593,7 +769,9 @@ If a third argument is specified, this will be the error message raised and seen
*Type*: statement
-* `validate_hash`: Validates that all passed values are hash data structures. Abort catalog compilation if any value fails this check.
+#### `validate_hash`
+
+Validates that all passed values are hash data structures. Abort catalog compilation if any value fails this check.
The following values will pass:
@@ -613,7 +791,9 @@ If a third argument is specified, this will be the error message raised and seen
*Type*: statement
-* `validate_integer`: Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail.
+#### `validate_integer`
+
+Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail.
The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max.
@@ -669,7 +849,9 @@ If a third argument is specified, this will be the error message raised and seen
*Type*: statement
-* `validate_numeric`: Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail.
+#### `validate_numeric`
+
+Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail.
The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max.
@@ -683,7 +865,9 @@ If a third argument is specified, this will be the error message raised and seen
*Type*: statement
-* `validate_re`: Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to
+#### `validate_re`
+
+Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to
test, and the second argument should be a stringified regular expression
(without the // delimiters) or an array of regular expressions. If none
of the regular expressions match the string passed in, compilation aborts with a parse error.
@@ -711,7 +895,9 @@ of the regular expressions match the string passed in, compilation aborts with a
*Type*: statement
-* `validate_slength`: Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if arg 2 is not convertable to a number.
+#### `validate_slength`
+
+Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if arg 2 is not convertable to a number.
The following values pass:
@@ -729,7 +915,9 @@ of the regular expressions match the string passed in, compilation aborts with a
*Type*: statement
-* `validate_string`: Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check.
+#### `validate_string`
+
+Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check.
The following values pass:
@@ -749,7 +937,9 @@ of the regular expressions match the string passed in, compilation aborts with a
*Type*: statement
-* `values`: When given a hash, this function returns the values of that hash.
+#### `values`
+
+When given a hash, this function returns the values of that hash.
*Examples:*
@@ -766,7 +956,9 @@ of the regular expressions match the string passed in, compilation aborts with a
*Type*: rvalue
-* `values_at`: Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can be a combination of:
+#### `values_at`
+
+Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can be a combination of:
* A single numeric index
* A range in the form of 'start-stop' (eg. 4-9)
@@ -776,7 +968,9 @@ of the regular expressions match the string passed in, compilation aborts with a
*Type*: rvalue
-* `zip`: Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue
+#### `zip`
+
+Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue
##Limitations