c050739f41
* Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
27 KiB
27 KiB
title, excerpt, layout
| title | excerpt | layout |
|---|---|---|
| push | Append an element to the end of an array. | manual |
Append an element to the end of an array.
Returns a new array with the element appended.
push(
array: [[[KclValue](/docs/kcl/types/KclValue)]](/docs/kcl/types/[KclValue](/docs/kcl/types/KclValue)),
item: [KclValue](/docs/kcl/types/KclValue),
): [KclValue](/docs/kcl/types/KclValue)
Arguments
| Name | Type | Description | Required |
|---|---|---|---|
array |
[KclValue] |
The array which you're adding a new item to. | Yes |
item |
KclValue |
The new item to add to the array | Yes |
Returns
KclValue - Any KCL value.
Examples
arr = [1, 2, 3]
new_arr = push(arr, item = 4)
assert(
new_arr[3],
isEqualTo = 4,
tolerance = 0.1,
error = "4 was added to the end of the array",
)