| Uses: | Ember.Enumerable |
|---|---|
| Defined in: | packages/ember-runtime/lib/mixins/mutable_enumerable.js:13 |
| Module: | ember |
Defined in packages/ember-runtime/lib/mixins/mutable_enumerable.js:55
Required. You must implement this method to apply this mixin.
Attempts to add the passed object to the receiver if the object is not already present in the collection. If the object is present, this method has no effect.
If the passed object is of a type not supported by the receiver, then this method should raise an exception.
Defined in packages/ember-runtime/lib/mixins/mutable_enumerable.js:72
Adds each object in the passed enumerable to the receiver.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:607
Returns true if the passed function returns true for any item in the enumeration.
The callback method you provide should have the following signature (all parameters are optional):
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 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:
if (people.any(isManager)) {
Paychecks.addBiggerBonus();
} Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:770
Returns a copy of the array with all null and undefined elements removed.
let arr = ['a', null, 'c', undefined]; arr.compact(); // ['a', 'c']
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:549
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):
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 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:
if (people.every(isEngineer)) {
Paychecks.addBigBonus();
} Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:366
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):
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 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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:440
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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:474
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):
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 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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:532
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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:241
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):
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.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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:292
Alias for mapBy
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:1104
Returns true if the passed object can be found in the enumerable.
[1, 2, 3].includes(2); // true [1, 2, 3].includes(4); // false [1, 2, undefined].includes(undefined); // true [1, 2, null].includes(null); // true [1, 2, NaN].includes(NaN); // true
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:729
Invokes the named method on every object in the receiver that implements it. This method corresponds to the implementation in Prototype 1.6.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:665
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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:588
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.
Note that like the native Array.every, isEvery will return true when called on any empty enumerable.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:318
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):
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 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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:353
Similar to map, this specialized function returns the value of the named property on all items in the enumeration.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:681
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):
function(previousValue, item, index, enumerable);
previousValue is the value returned by the last call to the iterator.item is the current item in the iteration.index is the current index in the iteration.enumerable is 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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:407
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):
function(item, index, enumerable);
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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:455
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.
Defined in packages/ember-runtime/lib/mixins/mutable_enumerable.js:87
Required. You must implement this method to apply this mixin.
Attempts to remove the passed object from the receiver collection if the object is present in the collection. If the object is not present, this method has no effect.
If the passed object is of a type not supported by the receiver, then this method should raise an exception.
Defined in packages/ember-runtime/lib/mixins/mutable_enumerable.js:105
Removes each object in the passed enumerable from the receiver.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:302
Sets the value on the named property for each member. This is more ergonomic 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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:1044
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.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:754
Simply converts the enumerable into a genuine array. The order is not guaranteed. Corresponds to the method implemented by Prototype.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:818
Returns a new enumerable that contains only unique values. The default implementation returns an array regardless of the receiver type.
let arr = ['a', 'a', 'b', 'b']; arr.uniq(); // ['a', 'b']
This only works on primitive data types, e.g. Strings, Numbers, etc.
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:1075
Returns a new enumerable that contains only items containing a unique property value. The default implementation returns an array regardless of the receiver type.
let arr = [{ value: 'a' }, { value: 'a' }, { value: 'b' }, { value: 'b' }];
arr.uniqBy('value'); // [{ value: 'a' }, { value: 'b' }] Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:786
Returns a new enumerable that excludes the passed value. The default implementation returns an array regardless of the receiver type. If the receiver does not contain the value it returns the original enumerable.
let arr = ['a', 'b', 'a', 'c'];
arr.without('a'); // ['b', 'c']
© 2017 Yehuda Katz, Tom Dale and Ember.js contributors
Licensed under the MIT License.
https://emberjs.com/api/ember/2.15/classes/Ember.MutableEnumerable/methods