Skip to content

Commit 7e50044

Browse files
committed
Add color about kinds of expected errors to README.
1 parent 2c75e71 commit 7e50044

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,36 @@ like to try those out, please see instructions in that repo!
137137
Here is the short list of things which do *not* work yet in the version of the
138138
typings published on DefinitelyTyped.
139139

140+
### Some `import`s don't resolve
141+
142+
You'll frequently see errors for imports which TypeScript doesn't know how to
143+
resolve. For example, if you use `htmlbars-inline-precompile`:
144+
145+
```typescript
146+
import hbs from 'htmlbars-inline-precompile';
147+
```
148+
149+
You'll see an error, because there aren't yet type definitions for it. You may
150+
see the same with some addons as well. These won't stop the build from working;
151+
they just mean TypeScript doesn't know where to find those.
152+
153+
Writing these missing type definitions is a great way to pitch in! Jump in
154+
\#topic-typescript on the Ember Slack and we'll be happy to help you.
155+
156+
### `extends` gives errors
157+
158+
You'll see quite a few errors like this when calling `.extends()` on an existing
159+
Ember type:
160+
161+
> Class 'FooController' incorrectly extends base class 'Controller'.
162+
> Type '{ bar(): void; }' has no properties in common with type 'ActionHash'
163+
164+
This is a symptom of the current, out-of-date types. The new typings we're
165+
working on will solve these.
166+
167+
In the meantime, note that your application will still build just fine even with
168+
these errors... they'll just be annoying.
169+
140170
### Type safety when invoking actions
141171

142172
TypeScript won't detect a mismatch between this action and the corresponding

0 commit comments

Comments
 (0)