arrayDeleteElement

Owned by Jonathan Muse
Last updated: Oct 16, 2024 by Shane Smith
1 min read

Description

If elem is an element of the array type, returns a new array without the specified element.

Parameters

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.

 

  1. If array is not defined as an array, the routine returns error.

  2. If elem is not the same type as declared in the array definition, the routine returns error.

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

Peacock