summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authordigitalcraftsman <digitalcraftsman@users.noreply.github.com>2017-03-12 23:04:12 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-03-12 23:04:12 +0100
commit5d0748ce51d0a86843bfd6569fd3cd18fa20ed5a (patch)
tree0f701a86fc3da58effb2ea2d6c4d14fbcb5f9d11 /docs
parent63e2a46f630ea95b6a82ddd7af240f87026871fb (diff)
tpl: Add union template func
Diffstat (limited to 'docs')
-rw-r--r--docs/content/templates/functions.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/content/templates/functions.md b/docs/content/templates/functions.md
index f20aebebc..e4c885c3c 100644
--- a/docs/content/templates/functions.md
+++ b/docs/content/templates/functions.md
@@ -214,6 +214,23 @@ e.g.
</ul>
+### union
+Given two arrays (or slices) A and B, this function will return a new array that contains the elements or objects that belong to either A or to B or to both. The elements supported are strings, integers and floats (only float64).
+
+```
+{{ union (slice 1 2 3) (slice 3 4 5) }}
+<!-- returns [1 2 3 4 5] -->
+
+{{ union (slice 1 2 3) nil }}
+<!-- returns [1 2 3] -->
+
+{{ union nil (slice 1 2 3) }}
+<!-- returns [1 2 3] -->
+
+{{ union nil nil }}
+<!-- returns an error because both arrays/slices have to be of the same type -->
+```
+
### isset
Returns true if the parameter is set.
Takes either a slice, array or channel and an index or a map and a key as input.