ember-source
Version:
A JavaScript framework for creating ambitious web applications
38 lines (31 loc) • 913 B
JavaScript
import Mixin from '../../../../object/mixin.js';
/**
@module ember
*/
/**
Implements some standard methods for comparing objects. Add this mixin to
any class you create that can compare its instances.
You should implement the `compare()` method.
@class Comparable
@namespace Ember
@since Ember 0.9
@private
*/
const Comparable = Mixin.create({
/**
__Required.__ You must implement this method to apply this mixin.
Override to return the result of the comparison of the two parameters. The
compare method should return:
- `-1` if `a < b`
- `0` if `a == b`
- `1` if `a > b`
Default implementation raises an exception.
@method compare
@param a {Object} the first object to compare
@param b {Object} the second object to compare
@return {Number} the result of the comparison
@private
*/
compare: null
});
export { Comparable as default };