Provides utility methods for working with arrays. Additional array helpers can
be found in the collection and array-extras modules.
Y.Array(thing) returns a native array created from thing. Depending on
thing's type, one of the following will happen:
Array.test()) are converted to arrays.Note: elements that are also collections, such as <form> and <select>
elements, are not automatically converted to arrays. To force a conversion,
pass true as the value of the force parameter.
Arraything
[startIndex=0]
[force=false]
Defined in
yui/js/yui-array.js:11
A native array created from thing, according to the rules described above.
dedupearray
Defined in
yui/js/yui-array.js:65
Available since 3.4.0
Dedupes an array of strings, returning an array that's guaranteed to contain only one copy of a given string.
This method differs from Array.unique() in that it's optimized for use only
with arrays consisting entirely of strings or entirely of numbers, whereas
unique may be used with other value types (but is slower).
Using dedupe() with values other than strings or numbers, or with arrays
containing a mix of strings and numbers, may result in unexpected behavior.
Copy of array containing no duplicate values.
eacharray
fn
[thisObj]
Defined in
yui/js/yui-array.js:114
Executes the supplied function on each item in the array. This method wraps
the native ES5 Array.forEach() method if available.
The YUI instance.
everya
f
[o]
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:166
Executes the supplied function on each item in the array. Iteration stops if the supplied function does not return a truthy value.
true if every item in the array returns true from the
supplied function, false otherwise.
filtera
f
[o]
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:113
Executes the supplied function on each item in the array. Returns a new array containing the items for which the supplied function returned a truthy value.
Array of items for which the supplied function returned a truthy value (empty if it never returned a truthy value).
finda
f
[o]
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:273
Executes the supplied function on each item in the array, searching for the first item that matches the supplied function.
the first item that the supplied function returns true for,
or null if it never returns true.
flattena
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:364
Available since 3.7.0
Flattens an array of nested arrays at any abitrary depth into a single, flat array.
a
Array
Array with nested arrays to flatten.
An array whose nested arrays have been flattened.
grepa
pattern
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:295
Iterates over an array, returning a new array of all the elements that match the supplied regular expression.
All the items in the array that produce a match against the supplied regular expression. If no items match, an empty array is returned.
hashkeys
[values]
Defined in
yui/js/yui-array.js:149
Returns an object using the first array as keys and the second as values. If
the second array is not provided, or if it doesn't contain the same number of
values as the first array, then true will be used in place of the missing
values.
Hash using the first array as keys and the second as values.
Y.Array.hash(['a', 'b', 'c'], ['foo', 'bar']);
// => {a: 'foo', b: 'bar', c: true}indexOfarray
value
[from=0]
Defined in
yui/js/yui-array.js:180
Returns the index of the first item in the array that's equal (using a strict
equality check) to the specified value, or -1 if the value isn't found.
This method wraps the native ES5 Array.indexOf() method if available.
Index of the item strictly equal to value, or -1 if not
found.
invokeitems
name
[args*]
Provided by the array-invoke module.
Defined in
collection/js/invoke.js:6
Executes a named method on each item in an array of objects. Items in the array that do not have a function by that name will be skipped.
All return values, indexed according to the item index.
Y.Array.invoke(arrayOfDrags, 'plug', Y.Plugin.DDProxy);lastIndexOfa
val
[fromIndex]
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:12
Returns the index of the last item in the array that contains the specified
value, or -1 if the value isn't found.
a
Array
Array to search in.
val
Any
Value to search for.
[fromIndex]
Number
optional
Index at which to start searching backwards.
Defaults to the array's length - 1. If negative, it will be taken as an offset
from the end of the array. If the calculated index is less than 0, the array
will not be searched and -1 will be returned.
Index of the item that contains the value, or -1 if not
found.
mapa
f
[o]
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:192
Executes the supplied function on each item in the array and returns a new array containing all the values returned by the supplied function.
A new array containing the return value of the supplied function for each item in the original array.
// Convert an array of numbers into an array of strings.
Y.Array.map([1, 2, 3, 4], function (item) {
return '' + item;
});
// => ['1', '2', '3', '4']numericSorta
b
Defined in
yui/js/yui-array.js:220
Numeric sort convenience function.
The native Array.prototype.sort() function converts values to strings and
sorts them in lexicographic order, which is unsuitable for sorting numeric
values. Provide Array.numericSort as a custom sort function when you want
to sort values in numeric order.
Difference between a and b.
[42, 23, 8, 16, 4, 15].sort(Y.Array.numericSort);
// => [4, 8, 15, 16, 23, 42]partitiona
f
[o]
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:312
Partitions an array into two new arrays, one with the items for which the
supplied function returns true, and one with the items for which the function
returns false.
An object with two properties: matches and rejects. Each is
an array containing the items that were selected or rejected by the test
function (or an empty array if none).
reducea
init
f
[o]
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:231
Executes the supplied function on each item in the array, "folding" the array into a single value.
Final result from iteratively applying the given function to each element in the array.
rejecta
f
[o]
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:148
The inverse of Array.filter(). Executes the supplied function on each item.
Returns a new array containing the items for which the supplied function
returned false.
The items for which the supplied function returned false.
somearray
fn
[thisObj]
Defined in
yui/js/yui-array.js:243
Executes the supplied function on each item in the array. Returning a truthy value from the function will stop the processing of remaining items.
true if the function returns a truthy value on any of the
items in the array; false otherwise.
testobj
Defined in
yui/js/yui-array.js:271
Evaluates obj to determine if it's an array, an array-like collection, or
something else. This is useful when working with the function arguments
collection and HTMLElement collections.
Note: This implementation doesn't consider elements that are also
collections, such as <form> and <select>, to be array-like.
obj
Object
Object to test.
A number indicating the results of the test:
uniquearray
[testFn]
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:55
Returns a copy of the input array with duplicate items removed.
Note: If the input array only contains strings, the Y.Array.dedupe() method is
a much faster alternative.
Copy of the input array with duplicate items removed.
zipa
a2
Provided by the array-extras module.
Defined in
collection/js/array-extras.js:344
Creates an array of arrays by pairing the corresponding elements of two arrays together into a new array.
An array of arrays formed by pairing each element of the first array with an item in the second array having the corresponding index.