Module: array

Module: array

Source:

Members

<inner> sortFunctions :Object

Sort functions
Type:
  • Object
Source:

Methods

<inner> clone(array) → {Array}

Clone an array
Parameters:
Name Type Description
array Array
Source:
Returns:
cloned array
Type
Array

<inner> equals(array1, array2) → {Boolean}

Tests if an array equals another
Parameters:
Name Type Description
array1 Array
array2 Array
Source:
Returns:
Type
Boolean

<inner> has(array, searchElement, i) → {Boolean}

Search if the array has an element. Shortcut for indexOf !== -1
Parameters:
Name Type Description
array Array
searchElement *
i Number
Source:
Returns:
Type
Boolean

<inner> hasAmong(array, searchElements, i) → {Boolean}

Search if the array has an element among provided elements. Shortcut for indexOf !== -1
Parameters:
Name Type Description
array Array
searchElements Array
i Number
Source:
Returns:
Type
Boolean

<inner> last(array) → {*}

Last element in an array
Parameters:
Name Type Description
array Array
Source:
Returns:
last element
Type
*

<inner> random(array) → {*}

Random element in an array
Parameters:
Name Type Description
array Array
Source:
Returns:
last element
Type
*

<inner> remove(array, element) → {Boolean}

Remove an element in an array
Parameters:
Name Type Description
array Array
element *
Source:
Returns:
Type
Boolean

<inner> removeWhen(array, callback) → {Number}

The removeWhen() method removes elements when element pass the test implemented by the provided function.
Parameters:
Name Type Description
array Array
callback function
Source:
Returns:
the new array's length
Type
Number

<inner> slice1(array) → {Array}

Slice the array by one element
Parameters:
Name Type Description
array Array
Source:
Returns:
Type
Array

<inner> sortBy(array, propertyName, descending, sortFunction) → {Array}

Sorts an array by a property
Parameters:
Name Type Argument Description
array Array
propertyName String
descending Boolean <nullable>
sortFunction function | String | undefined
Source:
Returns:
Type
Array