diff options
Diffstat (limited to 'docs/content/en/functions/merge.md')
| -rw-r--r-- | docs/content/en/functions/merge.md | 58 |
1 files changed, 44 insertions, 14 deletions
diff --git a/docs/content/en/functions/merge.md b/docs/content/en/functions/merge.md index a2c4cb87c..0944815a1 100644 --- a/docs/content/en/functions/merge.md +++ b/docs/content/en/functions/merge.md @@ -1,6 +1,6 @@ --- title: merge -description: "`merge` deep merges two maps and returns the resulting map." +description: "Returns the result of merging two or more maps." date: 2019-08-08 categories: [functions] menu: @@ -14,28 +14,58 @@ relatedfuncs: [dict, append, reflect.IsMap, reflect.IsSlice] aliases: [] --- -Merge creates a copy of the final `MAP` and merges any preceding `MAP` into it in reverse order. +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. -An example merging two maps. +The following examples use these map definitions: ```go-html-template -{{ $default_params := dict "color" "blue" "width" "50%" "height" "25%" "icon" "star" }} -{{ $user_params := dict "color" "red" "icon" "mail" "extra" (dict "duration" 2) }} -{{ $params := merge $default_params $user_params }} +{{ $m1 := dict "x" "foo" }} +{{ $m2 := dict "x" "bar" "y" "wibble" }} +{{ $m3 := dict "x" "baz" "y" "wobble" "z" (dict "a" "huey") }} ``` -Resulting __$params__: +Example 1 + +```go-html-template +{{ $merged := merge $m1 $m2 $m3 }} +{{ $merged.x }} --> baz +{{ $merged.y }} --> wobble +{{ $merged.z.a }} --> huey ``` -"color": "red" -"extra": - "duration": 2 -"height": "25%" -"icon": "mail" -"width": "50%" + +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]({{< ref "functions/append" >}}) +Regardless of depth, merging only applies to maps. For slices, use [append]({{< ref "functions/append" >}}). {{% /note %}} |