Skip to content

Commit

Permalink
add docs for deprecations
Browse files Browse the repository at this point in the history
  • Loading branch information
runspired committed Dec 6, 2019
1 parent 403049b commit 33ba6d5
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
2 changes: 1 addition & 1 deletion packages/canary-features/addon/default-features.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- null - The feature is disabled by default, but can be enabled at runtime via `EmberDataENV`.
@module @ember-data/canary-features
@main
@main @ember-data/canary-features
@private
*/
export default {
Expand Down
38 changes: 38 additions & 0 deletions packages/private-build-infra/addon/current-deprecations.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
/**
* ## Deprecations
*
* EmberData allows users to remove code that exists to support deprecated
* behaviors.
*
* If your app has resolved all deprecations present in a given version,
* you may specify that version as your "compatibility" version to remove
* the code that supported the deprecated behavior from your app.
*
* For instance, if a deprecation was introduced in 3.13, and the app specifies
* 3.13 as its minimum version compatibility, any deprecations introduced before
* or during 3.13 would be stripped away.
*
* An app can use a different version than what it specifies as it's compatibility
* version. For instance, an App could be using `3.16` while specifying compatibility
* with `3.12`. This would remove any deprecations that were present in or before `3.12`
* but keep support for anything deprecated in or abvoe `3.13`.
*
* ### Configuring Compatibility
*
* To configure your compatibility version, set the `compatWith` to the version you
* are compatible with on the `emberData` config in your `ember-cli-build.js` file.
*
* ```js
* let app = new EmberApp(defaults, {
* emberData: {
* compatWith: '3.12',
* },
* });
* ```
*
* The complete list of which versions specific deprecations will be removed in
* can be found [here](https://github.com/emberjs/data/tree/master/packages/private-build-infra/addon/current-deprecations.ts "List of EmberData Deprecations")
*
* @module @ember-data/deprecations
* @main @ember-data/deprecations
*/
export default {
DEPRECATE_CATCH_ALL: '99.0',
DEPRECATE_EVENTED_API_USAGE: '3.12',
Expand Down

0 comments on commit 33ba6d5

Please sign in to comment.