Availability
This routine is available starting with katl-commons 1.0.
Description
If elem is an element of the array type, returns a new array without the specified element.Alias
deleteElement(arrayName, elem)
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
arrayName | array | Yes | The array from which the new element is deleted |
elem | any | Yes | The element to be deleted. Must be the same type as the array type |
Return Type
array
Example
watchers = deleteElement(watchers, currentUser());
The result returned by the routine is assigned to the the same array watchers, so the initial array watchers will be modified.
Notes
- If array is not defined as an array, the routine returns error.
- If elem is not the same type as declared in the array definition, the routine returns error.
katl-commons 2.5 specific
Starting with version 2.5, there is a more powerful way to express these operations: array = array - element; or even better array -= element;
See also