Feature/add array replace nth function (#325)

dothebart · web-flow · commit c280a9a73cf4 · 2020-02-04T08:22:25.000+01:00
diff --git a/3.7/aql/functions-array.md b/3.7/aql/functions-array.md
@@ -546,7 +546,8 @@ Replace the element at *position* in *anyArray* with *replaceValue*.
 
 - **anyArray** (array): array with elements of arbitrary type
 - **position** (number): the position of the element to replace. Positions start
-  at 0. Negative positions are not supported.
+  at 0. Negative positions are supported, with -1 being the last array element.
+  If a negative *position* is out of bounds, then it is set to the first element (0)
 - **replaceValue** the value to be inserted at *position*
 - **defaultPaddingValue** to be used for padding if *position* is two or more
   elements beyond the last element in *anyArray*
@@ -599,6 +600,24 @@ RETURN REPLACE_NTH( [ "a", "b", "c" ], 6, "z", "y" )
 {% endaqlexample %}
 {% include aqlexample.html id=examplevar type=type query=query bind=bind result=result %}
 
+{% aqlexample examplevar="examplevar" type="type" query="query" bind="bind" result="result" %}
+@startDocuBlockInline aqlArrayReplaceNth_5
+@EXAMPLE_AQL{aqlArrayReplaceNth_5}
+RETURN REPLACE_NTH( [ "a", "b", "c" ], -1, "z" )
+@END_EXAMPLE_AQL
+@endDocuBlock aqlArrayReplaceNth_5
+{% endaqlexample %}
+{% include aqlexample.html id=examplevar type=type query=query bind=bind result=result %}
+
+{% aqlexample examplevar="examplevar" type="type" query="query" bind="bind" result="result" %}
+@startDocuBlockInline aqlArrayReplaceNth_6
+@EXAMPLE_AQL{aqlArrayReplaceNth_6}
+RETURN REPLACE_NTH( [ "a", "b", "c" ], -9, "z" )
+@END_EXAMPLE_AQL
+@endDocuBlock aqlArrayReplaceNth_6
+{% endaqlexample %}
+{% include aqlexample.html id=examplevar type=type query=query bind=bind result=result %}
+
 ## REMOVE_VALUE()
 
 `REMOVE_VALUE(anyArray, value, limit) → newArray`
