diff --git a/guides/release/typescript/core-concepts/ember-data.md b/guides/release/typescript/core-concepts/ember-data.md index 4290b52ee2..b4e742f8c6 100644 --- a/guides/release/typescript/core-concepts/ember-data.md +++ b/guides/release/typescript/core-concepts/ember-data.md @@ -2,6 +2,23 @@ In this section, we cover how to use TypeScript effectively with specific EmberD We do _not_ cover general usage of EmberData; instead, we assume that as background knowledge. Please see the [EmberData Guides][ED-guides] and [API docs][ED-api-docs]! +
+
+
+
Zoey says...
+
+

+ These guides currently assume you are using the EmberData @types packages in conjunction with the Ember @types packages. +

+

+ For improved (albeit less stable) types, you can switch to EmberData's alpha native types, documented at this link. Using the EmberData alpha native types will also require switching to the Ember native types, which are guaranteed to always be 100% correct and 100% up to date! +

+
+
+ +
+
+ ## Models EmberData models are normal TypeScript classes, but with properties decorated to define how the model represents an API resource and relationships to other resources. The decorators the library supplies "just work" with TypeScript at runtime, but require type annotations to be useful with TypeScript. Additionally, you must register each model with the [`ModelRegistry`][ED-registry] as shown in the examples below. diff --git a/guides/release/typescript/getting-started.md b/guides/release/typescript/getting-started.md index 88f045e843..560b96d015 100644 --- a/guides/release/typescript/getting-started.md +++ b/guides/release/typescript/getting-started.md @@ -33,7 +33,12 @@ The `typescript` package provides tooling to support TypeScript type checking an
Zoey says...
- Ember also publishes its own native types compiled directly from its source code, as described in this blog post. For now, we continue to use the @types packages by default for the sake of compatibility with EmberData, because EmberData is not yet compatible with Ember's native official types. However, if you do not use EmberData, we highly recommend following the instructions in that blog post to switch to the native types, which are guaranteed to always be 100% correct and 100% up to date! +

+ Ember also publishes its own native types compiled directly from its source code. For now, we continue to use the @types packages in these guides for the sake of compatibility with EmberData, because the EmberData @types packages are not compatible with Ember's native official types. +

+

+ If you do not use EmberData, or if you use EmberData's alpha native types, we highly recommend following the instructions in this blog post to switch to the native types, which are guaranteed to always be 100% correct and 100% up to date! +