-
-
Notifications
You must be signed in to change notification settings - Fork 71
docs(ember): add deprecation guide for Comparable mixin #1432
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
NullVoxPopuli
merged 5 commits into
ember-learn:main
from
olenderhub:add-comparable-mixin-deprecation-guide
Sep 1, 2026
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0ef3d79
docs(ember): add deprecation guide for Comparable mixin
olenderhub 9880088
Update comparable deprecation guide
NullVoxPopuli bbff3e0
Merge branch 'main' into add-comparable-mixin-deprecation-guide
ef4 8e26028
Update content/ember/v7/deprecate-comparable-mixin.md
NullVoxPopuli dba6bcd
Update deprecation version for Comparable mixin
NullVoxPopuli File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| title: Deprecate Comparable mixin | ||
| until: 7.5.0 | ||
| since: 7.2.0 | ||
| --- | ||
|
|
||
| The `Comparable` mixin is deprecated. This mixin was private but as it may have been intimate API, per our policy we've added a deprecation that will remain for at least one LTS. | ||
|
|
||
| Apps and addons should stop importing or extending `Comparable`. To provide custom comparison behavior, define a function-valued `compare(other)` method directly on the object or class instead. | ||
|
|
||
| Before: | ||
|
|
||
| ```js | ||
| import EmberObject from '@ember/object'; | ||
| import Comparable from '@ember/-internals/runtime/lib/mixins/comparable'; | ||
|
|
||
| const Rectangle = EmberObject.extend(Comparable, { | ||
| compare(other) { | ||
| // custom comparison logic | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| After: | ||
|
|
||
| ```js | ||
| class Rectangle { | ||
| // Returns -1, 0, 1 | ||
| compare(other) { | ||
| // custom comparison logic | ||
| }, | ||
| } | ||
| ``` | ||
|
|
||
| Defining `compare(other)` directly is sufficient. | ||
|
|
||
| However, if you need to `sort` a list of your objects, you will want to define a separate [`comparator function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description). | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@NullVoxPopuli did this actually land in 7.2?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah: emberjs/ember.js#21437
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It did, but it is also until 7.5 because it was private, so just an intimate api
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated