modeling-app/docs/kcl-std/push.md

title, subtitle, excerpt, layout

title	subtitle	excerpt	layout
push	Function in std::array	Append an element to the end of an array.	manual

Append an element to the end of an array.

push(
  @array: [any],
  item: any,
): any

Returns a new array with the element appended.

Arguments

Name	Type	Description	Required
array	[any]	The array which you're adding a new item to.	Yes
item	any	The new item to add to the array	Yes

Returns

any - 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",
)