diff options
Diffstat (limited to 'docs/content/en/functions/collections/Merge.md')
| -rw-r--r-- | docs/content/en/functions/collections/Merge.md | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/docs/content/en/functions/collections/Merge.md b/docs/content/en/functions/collections/Merge.md new file mode 100644 index 000000000..908f1738a --- /dev/null +++ b/docs/content/en/functions/collections/Merge.md @@ -0,0 +1,74 @@ +--- +title: collections.Merge +linkTitle: merge +description: Returns the result of merging two or more maps. +categories: [functions] +keywords: [] +menu: + docs: + parent: functions +function: + aliases: [merge] + returnType: any + signatures: [collections.Merge MAP MAP...] +relatedFunctions: + - collections.Append + - collections.Merge +aliases: [/functions/merge] +--- + +Returns the result of merging two or more maps from left to right. If a key already exists, `merge` updates its value. If a key is absent, `merge` inserts the value under the new key. + +Key handling is case-insensitive. + +The following examples use these map definitions: + +```go-html-template +{{ $m1 := dict "x" "foo" }} +{{ $m2 := dict "x" "bar" "y" "wibble" }} +{{ $m3 := dict "x" "baz" "y" "wobble" "z" (dict "a" "huey") }} +``` + +Example 1 + +```go-html-template +{{ $merged := merge $m1 $m2 $m3 }} + +{{ $merged.x }} → baz +{{ $merged.y }} → wobble +{{ $merged.z.a }} → huey +``` + +Example 2 + +```go-html-template +{{ $merged := merge $m3 $m2 $m1 }} + +{{ $merged.x }} → foo +{{ $merged.y }} → wibble +{{ $merged.z.a }} → huey +``` + +Example 3 + +```go-html-template +{{ $merged := merge $m2 $m3 $m1 }} + +{{ $merged.x }} → foo +{{ $merged.y }} → wobble +{{ $merged.z.a }} → huey +``` + +Example 4 + +```go-html-template +{{ $merged := merge $m1 $m3 $m2 }} + +{{ $merged.x }} → bar +{{ $merged.y }} → wibble +{{ $merged.z.a }} → huey +``` + +{{% note %}} +Regardless of depth, merging only applies to maps. For slices, use [append](/functions/collections/append). +{{% /note %}} |