A collection of Array methods.

• MDC Array

Calls a function for each element in the array.

myArray.each(fn[, bind]);

1. fn - (function) The function which should be executed on each item in the array. This function is passed the item and its index in the array.
2. bind - (object, optional) The object to be used as 'this' in the function. For more information see Function:bind.

fn(item, index, array)

1. item - (mixed) The current item in the array.
2. index - (number) The current item's index in the array.
3. array - (array) The actual array.

//Alerts "0 = apple", "1 = banana", and so on:
['apple', 'banana', 'lemon'].each(function(item, index){
    alert(index + " = " + item);
}); //The optional second argument for binding isn't used here.

• MDC Array:forEach

• This method is only available for browsers without native MDC Array:forEach support.

Returns true if every element in the array satisfies the provided testing function. This method is provided only for browsers without native Array:every support.

var allPassed = myArray.every(fn[, bind]);

1. fn - (function) The function to test for each element.
2. bind - (object, optional) The object to use as 'this' in the function. For more information see Function:bind.

fn(item, index, array)

1. item - (mixed) The current item in the array.
2. index - (number) The current item's index in the array.
3. array - (array) The actual array.

• (boolean) If every element in the array satisfies the provided testing function, returns true. Otherwise, returns false.

var areAllBigEnough = [10, 4, 25, 100].every(function(item, index){
    return item > 20;
}); //areAllBigEnough = false

• MDC Array:every

Creates a new array with all of the elements of the array for which the provided filtering function returns true. This method is provided only for browsers without native Array:filter support.

var filteredArray = myArray.filter(fn[, bind]);

1. fn - (function) The function to test each element of the array. This function is passed the item and its index in the array.
2. bind - (object, optional) The object to use as 'this' in the function. For more information see Function:bind.

fn(item, index, array)

1. item - (mixed) The current item in the array.
2. index - (number) The current item's index in the array.
3. array - (array) The actual array.

• (array) The new filtered array.

var biggerThanTwenty = [10, 3, 25, 100].filter(function(item, index){
    return item > 20;
}); //biggerThanTwenty = [25, 100]

• MDC Array:filter

Creates a new array with all of the elements of the array which are defined (i.e. not null or undefined).

var cleanedArray = myArray.clean();

• (array) The new filtered array.

var myArray = [null, 1, 0, true, false, "foo", undefined, ""];
myArray.clean() // returns [1, 0, true, false, "foo", ""]

Returns the index of the first element within the array equal to the specified value, or -1 if the value is not found. This method is provided only for browsers without native Array:indexOf support.

var index = myArray.indexOf(item[, from]);

• (number) The index of the first element within the array equal to the specified value. If not found, returns -1.

1. item - (object) The item to search for in the array.
2. from - (number, optional: defaults to 0) The index of the array at which to begin the search.

['apple', 'lemon', 'banana'].indexOf('lemon'); //returns 1
['apple', 'lemon'].indexOf('banana'); //returns -1

• MDC Array:indexOf

Creates a new array with the results of calling a provided function on every element in the array. This method is provided only for browsers without native Array:map support.

var mappedArray = myArray.map(fn[, bind]);

1. fn - (function) The function to produce an element of the new Array from an element of the current one.
2. bind - (object, optional) The object to use as 'this' in the function. For more information see Function:bind.

fn(item, index, array)

1. item - (mixed) The current item in the array.
2. index - (number) The current item's index in the array.
3. array - (array) The actual array.

• (array) The new mapped array.

var timesTwo = [1, 2, 3].map(function(item, index){
    return item * 2;
}); //timesTwo = [2, 4, 6];

• MDC Array:map

Returns true if at least one element in the array satisfies the provided testing function. This method is provided only for browsers without native Array:some support.

var somePassed = myArray.some(fn[, bind]);

• (boolean) If at least one element in the array satisfies the provided testing function returns true. Otherwise, returns false.

1. fn - (function) The function to test for each element. This function is passed the item and its index in the array.
2. bind - (object, optional) The object to use as 'this' in the function. For more information see Function:bind.

fn(item, index, array)

1. item - (mixed) The current item in the array.
2. index - (number) The current item's index in the array.
3. array - (array) The actual array.

var isAnyBigEnough = [10, 4, 25, 100].some(function(item, index){
    return item > 20;
}); //isAnyBigEnough = true

• MDC Array:some

Creates an object with key-value pairs based on the array of keywords passed in and the current content of the array.

var associated = myArray.associate(obj);

1. obj - (array) Its items will be used as the keys of the object that will be created.

• (object) The new associated object.

var animals = ['Cow', 'Pig', 'Dog', 'Cat'];
var sounds = ['Moo', 'Oink', 'Woof', 'Miao'];
sounds.associate(animals);
//returns {'Cow': 'Moo', 'Pig': 'Oink', 'Dog': 'Woof', 'Cat': 'Miao'}

Accepts an object of key / function pairs to assign values.

var result = Array.link(array, object);

1. object - (object) An object containing key / function pairs must be passed to be used as a template for associating values with the different keys.

• (object) The new associated object.

var el = document.createElement('div');
var arr2 = [100, 'Hello', {foo: 'bar'}, el, false];
arr2.link({myNumber: Number.type, myElement: Element.type, myObject: Object.type, myString: String.type, myBoolean: $defined});
//returns {myNumber: 100, myElement: el, myObject: {foo: 'bar'}, myString: 'Hello', myBoolean: false}

Tests an array for the presence of an item.

var inArray = myArray.contains(item[, from]);

1. item - (object) The item to search for in the array.
2. from - (number, optional: defaults to 0) The index of the array at which to begin the search.

• (boolean) If the array contains the item specified, returns true. Otherwise, returns false.

["a","b","c"].contains("a"); //returns true
["a","b","c"].contains("d"); //returns false

• MDC Array:indexOf

Extends an array with all the items of another.

myArray.extend(array);

1. array - (array) The array whose items should be extended into this array.

• (array) This array, extended.

var animals = ['Cow', 'Pig', 'Dog'];
animals.extend(['Cat', 'Dog']); //animals = ['Cow', 'Pig', 'Dog', 'Cat', 'Dog'];

Returns the last item from the array.

myArray.getLast();

• (mixed) The last item in this array.
• (null) If this array is empty, returns null.

['Cow', 'Pig', 'Dog', 'Cat'].getLast(); //returns 'Cat'

Returns a random item from the array.

myArray.getRandom();

• (mixed) A random item from this array. If this array is empty, returns null.

['Cow', 'Pig', 'Dog', 'Cat'].getRandom(); //returns one of the items

Pushes the passed element into the array if it's not already present (case and type sensitive).

myArray.include(item);

1. item - (object) The item that should be added to this array.

• (array) This array with the new item included.

['Cow', 'Pig', 'Dog'].include('Cat'); //returns ['Cow', 'Pig', 'Dog', 'Cat']
['Cow', 'Pig', 'Dog'].include('Dog'); //returns ['Cow', 'Pig', 'Dog']

Combines an array with all the items of another. Does not allow duplicates and is case and type sensitive.

myArray.combine(array);

1. array - (array) The array whose items should be combined into this array.

• (array) This array combined with the new items.

var animals = ['Cow', 'Pig', 'Dog'];
animals.combine(['Cat', 'Dog']); //animals = ['Cow', 'Pig', 'Dog', 'Cat'];

Removes all occurrences of an item from the array.

myArray.erase(item);

1. item - (object) The item to search for in the array.

• (array) This array with all occurrences of the item removed.

['Cow', 'Pig', 'Dog', 'Cat', 'Dog'].erase('Dog') //returns ['Cow', 'Pig', 'Cat']
['Cow', 'Pig', 'Dog'].erase('Cat') //returns ['Cow', 'Pig', 'Dog']

Empties an array.

myArray.empty();

• (array) This array, emptied.

var myArray = ['old', 'data'];
myArray.empty(); //myArray is now []

Flattens a multidimensional array into a single array.

myArray.flatten();

• (array) A new flat array.

var myArray = [1,2,3,[4,5, [6,7]], [[[8]]]];
var newArray = myArray.flatten(); //newArray is [1,2,3,4,5,6,7,8]

Converts an hexidecimal color value to RGB. Input array must be the following hexidecimal color format. ['FF','FF','FF']

myArray.hexToRgb([array]);

1. array - (boolean, optional) If true is passed, will output an array (eg. [255, 51, 0]) instead of a string (eg. "rgb(255,51,0)").

• (string) A string representing the color in RGB.
• (array) If the array flag is set, an array will be returned instead.

['11','22','33'].hexToRgb(); //returns "rgb(17,34,51)"
['11','22','33'].hexToRgb(true); //returns [17, 34, 51]

• String:hexToRgb

Converts an RGB color value to hexidecimal. Input array must be in one of the following RGB color formats. [255,255,255], or [255,255,255,1]

myArray.rgbToHex([array]);

1. array - (boolean, optional) If true is passed, will output an array (eg. ['ff','33','00']) instead of a string (eg. "#ff3300").

• (string) A string representing the color in hexadecimal, or 'transparent' string if the fourth value of rgba in the input array is 0 (rgba).
• (array) If the array flag is set, an array will be returned instead.

[17,34,51].rgbToHex(); //returns "#112233"
[17,34,51].rgbToHex(true); //returns ['11','22','33']
[17,34,51,0].rgbToHex(); //returns "transparent"

• String:rgbToHex

Creates a copy of an Array. Useful for applying the Array prototypes to iterable objects such as a DOM Node collection or the arguments object.

var copiedArray = $A(iterable);

1. iterable - (array) The iterable to copy.

• (array) The new copied array.

function myFunction(){
    $A(arguments).each(function(argument, index){
        alert(argument);
    });
};
myFunction("One", "Two", "Three"); //Alerts "One", then "Two", then "Three".

var anArray = [0, 1, 2, 3, 4];
var copiedArray = $A(anArray); //Returns [0, 1, 2, 3, 4].