Availability
This routine is available since katl-commons 1.0 .
Syntax
arraySetElement(array, index1, elem)
Description:
If elem is an element of the array type, returns a new array with the specified element on position index1 . If index1 is greater than the array size, it will add empty elements on the missing positions.Alias:
setElement(array, index1, elem)
Parameters:
Parameter name | Type | Required | Description |
---|---|---|---|
array | array | Yes | The array where to add the element |
index1 | number | Yes | Position where to add the element |
elem | type of array element | Yes | Element to add to the array |
Returns:
Element of the array type
Example:
watchers = setElement(watchers, 12, currentUser());
Sets the value currentUser for the 13 th element of the array watchers
Notes:
- If array is not defined as an array, the routine returns error.
- If index is not number the routine returns error.
katl-commons 2.5 specific
Since 2.5 we added the indexing operator. It will work on arrays, strings, dates and interval.
It was greatly awaited and it's now there.
You can simply write in your programs watchers[12] = currentUser() to refer to the 13 th element in the watchers array.
See Also: