Skip to content

Commit f82c1f3

Browse files
authored
update BREAKING.md for new tsc version (#938)
Add a line entry for new TypeScript breaking changes.
1 parent 2a26c19 commit f82c1f3

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

BREAKING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
# 0.13 Breaking Changes
2+
3+
- [Fluid Packages Require Consumers on TypeScript `>=3.6`](##Fluid-Packages-Require-Consumers-on-TypeScript->=3.6)
4+
5+
## Fluid Packages Require Consumers on TypeScript `>=3.6`
6+
7+
Fluid now requires consumers of our packages to use a TypeScript compiler version `>=3.6`. The Fluid `./packages` repo has upgraded to TypeScript `3.7.4`. TypeScript 3.7 has a breaking change to the `.d.ts` format having to do with getters and setters and is part of an effort to do [Class Field Mitigations](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#class-field-mitigations).
8+
9+
TypeScript now emits `get/set` accessors in `.d.ts` files. TypeScript versions `3.5` and prior do not know how to read these and throw the below error when compiling. TypeScript version `3.6` is forwards compatible but does not emit the accessors.
10+
11+
```text
12+
"error TS1086: An accessor cannot be declared in an ambient context."
13+
```
14+
15+
More about the changes:
16+
17+
- [Class Field Mitigations](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#class-field-mitigations)
18+
- [Full list of TypeScript changes](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html)
19+
120
# 0.12 Breaking Changes
221

322
- [Packages moved from packages to server](#Packages-moved-from-packages-to-server)

0 commit comments

Comments
 (0)