Class Enumerable

private

Defined in: packages/ember-runtime/lib/mixins/enumerable.js:56

Since: vEmber 0.9

import Enumerable from '@ember/enumerable';

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.Object subclass, you should be sure to change the length property using set().
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.

Show: Inherited Protected Private Deprecated

firstObject Object public

Module: @ember/enumerable

Defined in packages/ember-runtime/lib/mixins/enumerable.js:133

returns: Object; the object or undefined

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.

let arr = ['a', 'b', 'c'];
arr.get('firstObject');  // 'a'

let arr = [];
arr.get('firstObject');  // undefined

lastObject Object public

Module: @ember/enumerable

Defined in packages/ember-runtime/lib/mixins/enumerable.js:170

returns: Object; the last object or undefined

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.

let arr = ['a', 'b', 'c'];
arr.get('lastObject');  // 'c'

let arr = [];
arr.get('lastObject');  // undefined