Skip to content

Commit 6bd87ad

Browse files
committed
docs: update documentation
1 parent 619f496 commit 6bd87ad

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

enum-plus v3.md renamed to enum-plus-v3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
- [x] Reuse one copy of testing code for both `Jest` and `e2e` testing.
2020
- [x] Remove `private member` syntax from the codebase.
2121
- [x] Support graceful downgrade for multiple TypeScript versions. For `v5.0` and later, Enum initializations allows omitting the `as const` assertion. For earlier versions, will be automatically downgraded to the earlier syntax, just manually adding `as const` as needed.
22-
- [ ] Remove the internal `proxy` from `EnumItemClass`, and use `getter` instead. The reason is to avoid self-references to support `JSON.stringify` and to run in WeChat mini-programs.
22+
- [x] Remove the internal `proxy` from `EnumItemClass`, and use `getter` instead. The reason is to avoid self-references to support `JSON.stringify` and to run in WeChat mini-programs.
2323

2424
### Plugin System
2525

migrate-from-v2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The following methods are deprecated and permanently removed. However they both
2727

2828
## 🛠 Recommended to upgrade TypeScript to 5.0
2929

30-
We recommend upgrading your TypeScript version to `5.0` or later, as we introduced the [const Type Parameters](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-0.html#const-type-parameters) feature to simplify Enum initializations by removing the need for `as const`. The `Enum` can now be initialized with literal objects without the need of `as const` assertion.
30+
We recommend upgrading your TypeScript version to `v5.0` or later, as we have introduced the [const Type Parameters](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-0.html#const-type-parameters) feature to simplify Enum initializations. You don't have to use `as const` anymore. The `Enum` can now be initialized with literal objects by default.
3131

3232
```js
3333
const WeekEnum = Enum({
@@ -36,4 +36,4 @@ const WeekEnum = Enum({
3636
});
3737
```
3838

39-
> TypeScript `4.9` or earlier is still backward compatible. You will have to add `as const` manually, just like before.
39+
> If you can't upgrade, don't worry. TypeScript `4.9` or earlier is still backward compatible. You will have to add `as const` manually, just like before.

0 commit comments

Comments
 (0)