summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJames Nugent <james@jen20.com>2017-05-17 20:48:12 -0400
committerDave Henderson <dhenderson@gmail.com>2017-05-18 18:10:19 -0400
commit8218e45cbcc756333bee6b6245ef5a4c2aaa273f (patch)
tree2348f35d33fd05a5f318854d6d447455f33bf727 /README.md
parent8d5f38e2b0bab1117e82ddc6558ae5844e283496 (diff)
Add "replaceAll" function and documentation
This commit adds a `replaceAll` function which takes three arguments - an original string, the substring to replace, and the string with which to replace it. This is of particular use when generating node names from IP addresses where the node name may not contain "." characters.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 92b8085f..cb60f2c6 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,7 @@ Gomplate is an alternative that will let you process templates which also includ
- [`slice`](#slice)
- [`split`](#split)
- [`splitN`](#splitn)
+ - [`replaceAll`](#replaceAll)
- [`title`](#title)
- [`toLower`](#tolower)
- [`toUpper`](#toupper)
@@ -355,6 +356,23 @@ $ gomplate -i '{{ range splitN "foo:bar:baz" ":" 2 }}{{.}}{{end}}'
foo
bar:baz
```
+#### `replaceAll`
+
+Replaces all occurrences of a given string with another.
+
+##### Example
+
+```console
+$ gomplate -i '{{ replaceAll "." "-" "172.21.1.42" }}'
+172-21-1-42
+```
+
+##### Example (with pipeline)
+
+```console
+$ gomplate -i '{{ "172.21.1.42" | replaceAll "." "-" }}'
+172-21-1-42
+```
#### `title`