diff options
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index 4eca785..03daae9 100644 --- a/README.markdown +++ b/README.markdown @@ -209,6 +209,8 @@ Converts a string to and from base64 encoding. Requires an `action` ('encode', ' For backward compatibility, `method` will be set as `default` if not specified. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + *Examples:* ~~~ base64('encode', 'hello') @@ -263,10 +265,18 @@ bool2str(false, 't', 'f') => 'f' Requires a single boolean as input. *Type*: rvalue. +#### `camelcase` + +Converts the case of a string or all strings in an array to camel case. *Type*: rvalue. + +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `capitalize` Capitalizes the first character of a string or array of strings and lowercases the remaining characters of each string. Requires either a single string or an array as an input. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `ceiling` Returns the smallest integer greater than or equal to the argument. Takes a single numeric value as an argument. *Type*: rvalue. @@ -349,6 +359,8 @@ Deletes a determined indexed value from an array. For example, `delete_at(['a',' Deletes all instances of a given element from an array or hash that match a provided regular expression. A string will be treated as a one-item array. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + For example, `delete_regex(['a','b','c','b'], 'b')` returns ['a','c']; `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}, `delete_regex(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. `delete_regex(['ab', 'b'], 'b')` returns ['ab']. *Type*: rvalue. @@ -477,6 +489,8 @@ See also [unix2dos](#unix2dos). Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `empty` Returns true if the argument is an array or hash that contains no elements, or an empty string. Returns false when the argument is a numerical value. *Type*: rvalue. @@ -1014,6 +1028,8 @@ The third argument to this function is the salt to use. *Type*: rvalue. +**Please note:** This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + **Note:** this uses the Puppet master's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. #### `range` @@ -1093,6 +1109,8 @@ Returns the number of elements in a string, an array or a hash. May get confused Sorts strings and arrays lexically. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `squeeze` Returns a new string where runs of the same character that occur in this set are replaced by a single character. *Type*: rvalue. @@ -1106,10 +1124,14 @@ Converts certain strings to a boolean. This attempts to convert strings that con 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. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `strftime` Returns formatted time. For example, `strftime("%s")` returns the time since Unix epoch, and `strftime("%Y-%m-%d")` returns the date. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + *Format:* * `%a`: The abbreviated weekday name ('Sun') @@ -1175,6 +1197,8 @@ For example: Swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `time` Returns the current Unix epoch time as an integer. For example, `time()` returns something like '1311972653'. *Type*: rvalue. @@ -1262,10 +1286,14 @@ See also [dos2unix](#dos2unix). Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase('abcd')` returns 'ABCD'. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `uriescape` URLEncodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `validate_absolute_path` Validates that a given string represents an absolute path in the filesystem. Works for Windows and Unix style paths. |