Ember.Enumerable Class packages/ember-runtime/lib/mixins/enumerable.js:58
PRIVATE
Defined in: packages/ember-runtime/lib/mixins/enumerable.js:58
Module: ember-runtime
This mixin defines the common interface implemented by enumerable objects in Ember. Most of these methods follow the standard Array iteration API defined up to JavaScript 1.8 (excluding language-specific features that cannot be emulated in older versions of JavaScript).
This mixin is applied automatically to the Array class on page load, so you can use any of these methods on simple arrays. If Array already implements one of these methods, the mixin will not override them.
Writing Your Own Enumerable
To make your own custom class enumerable, you need two items:
You must have a length property. This property should change whenever the number of items in your enumerable object changes. If you use this with an
Ember.Objectsubclass, you should be sure to change the length property usingset().You must implement
nextObject().See documentation.
Once you have these two methods implemented, apply the Ember.Enumerable mixin
to your class and you will be able to enumerate the contents of your object
like any other collection.
Using Ember Enumeration with Other Libraries
Many other libraries provide some kind of iterator or enumeration like facility. This is often where the most common API conflicts occur. Ember's API is designed to be as friendly as possible with other libraries by implementing only methods that mostly correspond to the JavaScript 1.8 API.
Methods
- addEnumerableObserver
- any
- compact
- contains
- enumerableContentDidChange
- enumerableContentWillChange
- every
- filter
- filterBy
- find
- findBy
- forEach
- getEach
- invoke
- isAny
- isEvery
- map
- mapBy
- nextObject
- reduce
- reject
- rejectBy
- removeEnumerableObserver
- setEach
- sortBy
- toArray
- uniq
- without
Properties
addEnumerableObserver
(target, opts)
private
Registers an enumerable observer. Must implement Ember.EnumerableObserver
mixin.
Parameters:
- target Object
- opts [Object]
Returns:
- this
any
(callback, target)
Boolean
public
Returns true if the passed function returns true for any item in the
enumeration. This corresponds with the some() method in JavaScript 1.6.
The callback method you provide should have the following signature (all parameters are optional):
1 |
function(item, index, enumerable);
|
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
It should return the true to include the item in the results, false
otherwise.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
Usage Example:
1 2 3 |
if (people.any(isManager)) {
Paychecks.addBiggerBonus();
}
|
Parameters:
- callback Function
- The callback to execute
- target [Object]
- The target object to use
Returns:
- Boolean
- `true` if the passed function returns `true` for any item
compact
Array
public
Returns a copy of the array with all null and undefined elements removed.
1 2 |
var arr = ['a', null, 'c', undefined]; arr.compact(); // ['a', 'c'] |
Returns:
- Array
- the array without null and undefined elements.
contains
(obj)
Boolean
public
Returns true if the passed object can be found in the receiver. The
default version will iterate through the enumerable until the object
is found. You may want to override this with a more efficient version.
1 2 3 4 |
var arr = ['a', 'b', 'c']; arr.contains('a'); // true arr.contains('z'); // false |
Parameters:
- obj Object
- The object to search for.
Returns:
- Boolean
- `true` if object is found in enumerable.
enumerableContentDidChange
(removing, adding)
private
Invoke this method when the contents of your enumerable has changed. This will notify any observers watching for content changes. If you are implementing an ordered enumerable (such as an array), also pass the start and end values where the content changed so that it can be used to notify range observers.
Parameters:
- removing Ember.Enumerable|Number
- An enumerable of the objects to be removed or the number of items to be removed.
- adding Ember.Enumerable|Number
- An enumerable of the objects to be added or the number of items to be added.
enumerableContentWillChange
(removing, adding)
private
Invoke this method just before the contents of your enumerable will change. You can either omit the parameters completely or pass the objects to be removed or added if available or just a count.
Parameters:
- removing Ember.Enumerable|Number
- An enumerable of the objects to be removed or the number of items to be removed.
- adding Ember.Enumerable|Number
- An enumerable of the objects to be added or the number of items to be added.
every
(callback, target)
Boolean
public
Returns true if the passed function returns true for every item in the
enumeration. This corresponds with the every() method in JavaScript 1.6.
The callback method you provide should have the following signature (all parameters are optional):
1 |
function(item, index, enumerable);
|
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
It should return the true or false.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
Example Usage:
1 2 3 |
if (people.every(isEngineer)) {
Paychecks.addBigBonus();
}
|
Parameters:
- callback Function
- The callback to execute
- target [Object]
- The target object to use
Returns:
- Boolean
filter
(callback, target)
Array
public
Returns an array with all of the items in the enumeration that the passed
function returns true for. This method corresponds to filter() defined in
JavaScript 1.6.
The callback method you provide should have the following signature (all parameters are optional):
1 |
function(item, index, enumerable);
|
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
It should return true to include the item in the results, false
otherwise.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
Parameters:
- callback Function
- The callback to execute
- target [Object]
- The target object to use
Returns:
- Array
- A filtered array.
filterBy
(key, value)
Array
public
Returns an array with just the items with the matched property. You
can pass an optional second argument with the target value. Otherwise
this will match any property that evaluates to true.
Parameters:
- key String
- the property to test
- value [*]
- optional value to test against.
Returns:
- Array
- filtered array
find
(callback, target)
Object
public
Returns the first item in the array for which the callback returns true.
This method works similar to the filter() method defined in JavaScript 1.6
except that it will stop working on the array once a match is found.
The callback method you provide should have the following signature (all parameters are optional):
1 |
function(item, index, enumerable);
|
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
It should return the true to include the item in the results, false
otherwise.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
Parameters:
- callback Function
- The callback to execute
- target [Object]
- The target object to use
Returns:
- Object
- Found item or `undefined`.
findBy
(key, value)
Object
public
Returns the first item with a property matching the passed value. You
can pass an optional second argument with the target value. Otherwise
this will match any property that evaluates to true.
This method works much like the more generic find() method.
Returns:
- Object
- found item or `undefined`
forEach
(callback, target)
Object
public
Iterates through the enumerable, calling the passed function on each
item. This method corresponds to the forEach() method defined in
JavaScript 1.6.
The callback method you provide should have the following signature (all parameters are optional):
1 |
function(item, index, enumerable);
|
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
Parameters:
- callback Function
- The callback to execute
- target [Object]
- The target object to use
Returns:
- Object
- receiver
getEach
(key)
Array
public
Alias for mapBy
Parameters:
- key String
- name of the property
Returns:
- Array
- The mapped array.
invoke
(methodName, args)
Array
public
Invokes the named method on every object in the receiver that implements it. This method corresponds to the implementation in Prototype 1.6.
Parameters:
- methodName String
- the name of the method
- args Object...
- optional arguments to pass as well.
Returns:
- Array
- return values from calling invoke.
isAny
(key, value)
Boolean
public
Returns true if the passed property resolves to the value of the second
argument for any item in the enumerable. This method is often simpler/faster
than using a callback.
Parameters:
Returns:
- Boolean
isEvery
(key, value)
Boolean
public
Returns true if the passed property resolves to the value of the second
argument for all items in the enumerable. This method is often simpler/faster
than using a callback.
Parameters:
Returns:
- Boolean
map
(callback, target)
Array
public
Maps all of the items in the enumeration to another value, returning
a new array. This method corresponds to map() defined in JavaScript 1.6.
The callback method you provide should have the following signature (all parameters are optional):
1 |
function(item, index, enumerable);
|
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
It should return the mapped value.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
Parameters:
- callback Function
- The callback to execute
- target [Object]
- The target object to use
Returns:
- Array
- The mapped array.
mapBy
(key)
Array
public
Similar to map, this specialized function returns the value of the named property on all items in the enumeration.
Parameters:
- key String
- name of the property
Returns:
- Array
- The mapped array.
nextObject
(index, previousObject, context)
Object
private
Required. You must implement this method to apply this mixin.
Implement this method to make your class enumerable.
This method will be called repeatedly during enumeration. The index value will always begin with 0 and increment monotonically. You don't have to rely on the index value to determine what object to return, but you should always check the value and start from the beginning when you see the requested index is 0.
The previousObject is the object that was returned from the last call
to nextObject for the current iteration. This is a useful way to
manage iteration if you are tracing a linked list, for example.
Finally the context parameter will always contain a hash you can use as a "scratchpad" to maintain any other state you need in order to iterate properly. The context object is reused and is not reset between iterations so make sure you setup the context with a fresh state whenever the index parameter is 0.
Generally iterators will continue to call nextObject until the index
reaches the current length-1. If you run out of data before this
time for some reason, you should simply return undefined.
The default implementation of this method simply looks up the index. This works great on any Array-like objects.
Parameters:
- index Number
- the current index of the iteration
- previousObject Object
- the value returned by the last call to `nextObject`.
- context Object
- a context object you can use to maintain state.
Returns:
- Object
- the next object in the iteration or undefined
reduce
(callback, initialValue, reducerProperty)
Object
public
This will combine the values of the enumerator into a single value. It
is a useful way to collect a summary value from an enumeration. This
corresponds to the reduce() method defined in JavaScript 1.8.
The callback method you provide should have the following signature (all parameters are optional):
1 |
function(previousValue, item, index, enumerable);
|
previousValueis the value returned by the last call to the iterator.itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
Return the new cumulative value.
In addition to the callback you can also pass an initialValue. An error
will be raised if you do not pass an initial value and the enumerator is
empty.
Note that unlike the other methods, this method does not allow you to pass a target object to set as this for the callback. It's part of the spec. Sorry.
Parameters:
Returns:
- Object
- The reduced value.
reject
(callback, target)
Array
public
Returns an array with all of the items in the enumeration where the passed function returns false. This method is the inverse of filter().
The callback method you provide should have the following signature (all parameters are optional):
1 |
function(item, index, enumerable);
|
- item is the current item in the iteration.
- index is the current index in the iteration
- enumerable is the enumerable object itself.
It should return a falsey value to include the item in the results.
Note that in addition to a callback, you can also pass an optional target object that will be set as "this" on the context. This is a good way to give your iterator function access to the current object.
Parameters:
- callback Function
- The callback to execute
- target [Object]
- The target object to use
Returns:
- Array
- A rejected array.
rejectBy
(key, value)
Array
public
Returns an array with the items that do not have truthy values for key. You can pass an optional second argument with the target value. Otherwise this will match any property that evaluates to false.
Returns:
- Array
- rejected array
removeEnumerableObserver
(target, opts)
private
Removes a registered enumerable observer.
Parameters:
- target Object
- opts [Object]
Returns:
- this
setEach
(key, value)
Object
public
Sets the value on the named property for each member. This is more
efficient than using other methods defined on this helper. If the object
implements Ember.Observable, the value will be changed to set(), otherwise
it will be set directly. null objects are skipped.
Parameters:
- key String
- The key to set
- value Object
- The object to set
Returns:
- Object
- receiver
sortBy
(property)
Array
public
Converts the enumerable into an array and sorts by the keys specified in the argument.
You may provide multiple arguments to sort by multiple properties.
Parameters:
- property String
- name(s) to sort on
Returns:
- Array
- The sorted array.
toArray
Array
public
Simply converts the enumerable into a genuine array. The order is not guaranteed. Corresponds to the method implemented by Prototype.
Returns:
- Array
- the enumerable as an array.
uniq
Ember.Enumerable
public
Returns a new enumerable that contains only unique values. The default implementation returns an array regardless of the receiver type.
1 2 |
var arr = ['a', 'a', 'b', 'b']; arr.uniq(); // ['a', 'b'] |
This only works on primitive data types, e.g. Strings, Numbers, etc.
Returns:
without
(value)
Ember.Enumerable
public
Returns a new enumerable that excludes the passed value. The default implementation returns an array regardless of the receiver type unless the receiver does not contain the value.
1 2 |
var arr = ['a', 'b', 'a', 'c']; arr.without('a'); // ['b', 'c'] |
Parameters:
- value Object
Returns:
[]
Array
private
This property will trigger anytime the enumerable's content changes. You can observe this property to be notified of changes to the enumerable's content.
For plain enumerables, this property is read only. Array overrides
this method.
Returns:
- this
firstObject
Object
public
Helper method returns the first object from a collection. This is usually used by bindings and other parts of the framework to extract a single object if the enumerable contains only one item.
If you override this method, you should implement it so that it will
always return the same value each time it is called. If your enumerable
contains only one object, this method should always return that object.
If your enumerable is empty, this method should return undefined.
1 2 3 4 5 |
var arr = ['a', 'b', 'c']; arr.get('firstObject'); // 'a' var arr = []; arr.get('firstObject'); // undefined |
Returns:
- Object
- the object or undefined
hasEnumerableObservers
Boolean
private
Becomes true whenever the array currently has observers watching changes on the array.
lastObject
Object
public
Helper method returns the last object from a collection. If your enumerable
contains only one object, this method should always return that object.
If your enumerable is empty, this method should return undefined.
1 2 3 4 5 |
var arr = ['a', 'b', 'c']; arr.get('lastObject'); // 'c' var arr = []; arr.get('lastObject'); // undefined |
Returns:
- Object
- the last object or undefined