Skip to content

Commit 2fefd3c

Browse files
authored
Update MIGRATING.md
1 parent bf3f192 commit 2fefd3c

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

MIGRATING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,18 @@ module: {
5454

5555
</details>
5656

57-
## JSDoc (Not using TS)
57+
## JSDoc
5858

5959
- https://github.com/Microsoft/TypeScript/wiki/JsDoc-support-in-JavaScript
6060
- webpack's codebase uses JSDoc with linting by TS https://twitter.com/TheLarkInn/status/984479953927327744 (some crazy hack: https://twitter.com/thelarkinn/status/996475530944823296)
61-
-
61+
62+
Problems to be aware of:
63+
64+
- `object` is converted to `any` for some reason.
65+
- If you have an error in the jsdoc, you get no warning/error. TS just silently doesn't type annotate the function.
66+
- [casting can be verbose](https://twitter.com/bahmutov/status/1089229349637754880)
67+
68+
(*thanks [Gil Tayar](https://twitter.com/giltayar/status/1089228919260221441) and [Gleb Bahmutov](https://twitter.com/bahmutov/status/1089229196247908353) for sharing above commentary*)
6269

6370
## From JS
6471

0 commit comments

Comments
 (0)