► caplin.core.ArrayUtility()

This is a static class that never needs to be instantiated.

► <static> boolean inArray(Array pArray, Variant vValueToFind)

Return true if the input array contains the input value, false otherwise.

Returns

true if the specified value was found in the array, false otherwise.

► <static> Array intersect(Varargs One)

Creates an intersect of the supplied arrays. This is a new array with new indexes that contain all the values that occur in all of the supplied arrays with no duplicates.

Returns

The intersection of the arrays.

► <static> boolean isEqual(Array pArray1, Array pArray2)

Compares all elements of two arrays for equality. If either array is null or undefined this function will return false.

Note: The comparison is performed with ===, so if nested arrays or maps are not identical, this function will return false even if they contain the exact same elements. However, this method will work with NaN, so arrays containing NaN can be equal to each other.

Returns

true if the arrays are the same length and all elements are equal and of same type.

► <static> Array removeItem(Array pArray, Variant vValueToRemove)

Removes the first example of the specified item in the specified array, or does nothing if the item is not found.

Since this method uses the built-in indexOf which does work with NaN, it will not work if called with NaN and will throw an ArgumentError. If you need to remove NaN, you'll have to loop over the array and then splice it out.

Returns

{Array} The input array with the specified item removed, or the original array if the item was not found.

► <static> Array subtract(Varargs One)

Subtracts one or more arrays from the first array argument. In other words, it creates a copy of the first array argument, and then removes all items that appear in any of the subsequent array arguments.

Returns

The complement of the first array argument, with respect to the subsequent arguments.

► <static> Array union(Varargs One)

Creates a union of the supplied arrays. This is a new array with new indexes that contain all the values of the supplied arrays with no duplicates.

Returns

The union of the arrays.

► <static> Array unique(Array pArray)

Returns a new array containing each item in the input array once.

WARNING: This function is slow for big lists. Consider using uniquePrimitive if your use-case allows.

Returns

{Array} A new array of unique values found in the input array. Will not be null or undefined.

► <static> Array uniquePrimitive(Array pArray)

Returns an array of the unique values contained within the input array.

WARNING: does not work on arrays containing non key-able values (e.g. objects, arrays). use only with arrays containing strings and/or numbers.

Will throw a TypeError if it finds an item in the array of type object.

Returns

{Array} A new array of unique values found in the input array. Will not be null or undefined.