Skip to content

Commit a7af9c3

Browse files
committed
Add notes about Ember 3.1 support.
1 parent 934bec2 commit a7af9c3

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Use TypeScript in your Ember 2.x and 3.x apps!
66

77
* [Setup and Configuration](#setup-and-configuration)
88
* [Ember Support](#ember-support)
9+
* [:construction: Ember 3.1](#construction-ember-31)
910
* [`tsconfig.json`](#tsconfigjson)
1011
* [Sourcemaps](#sourcemaps)
1112
* [Using TypeScript with Ember effectively](#using-typescript-with-ember-effectively)
@@ -67,6 +68,12 @@ In addition to ember-cli-typescript, we make the following changes to your proje
6768

6869
ember-cli-typescript runs its test suite against the 2.12 LTS, the 2.16 LTS, the 2.18 LTS, the current release, the beta branch, and the canary branch. It's also in active use in several large applications. Any breakage for upcoming releases _should_ be detected and fixed ahead of those releases, but you can help us guarantee that by running your own Ember.js+TypeScript app with beta and canary turned on and let us know if you run into issues with upcoming Ember.js releases.
6970

71+
#### :construction: Ember 3.1
72+
73+
Support for (mostly in the form of documentation!) for the changes in Ember 3.1 is inbound shortly. You *can* use this addon with Ember 3.1, but the docs are not yet updated, and some of the patterns recommended below will actually cause your app to break. :grimacing: Come ping us in #topic-typescript in the [Ember Community Slack][Slack] and we'll help you. (And updated docs for 3.1 are inbound *soon*!)
74+
75+
[Slack]: https://ember-community-slackin.herokuapp.com
76+
7077
### `tsconfig.json`
7178

7279
We generate a good default [`tsconfig.json`][blueprint], which will usually make everything _Just Work_. In general, you may customize your TypeScript build process as usual using the `tsconfig.json` file.
@@ -628,7 +635,7 @@ import { task } from 'ember-concurrency';
628635

629636
You'll see an error, because there aren't yet type definitions for it. You may see the same with some addons as well. **These won't stop the build from working;** they just mean TypeScript doesn't know where to find those.
630637

631-
Writing these missing type definitions is a great way to pitch in! Jump in \#topic-typescript on the Ember Slack and we'll be happy to help you.
638+
Writing these missing type definitions is a great way to pitch in! Jump in \#topic-typescript on the [Ember Slack][Slack] and we'll be happy to help you.
632639

633640
### Type safety when invoking actions
634641

0 commit comments

Comments
 (0)