Skip to content

Commit 7101cb9

Browse files
committed
docs(README): typo
1 parent 7203e73 commit 7101cb9

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![](https://img.shields.io/npm/v/ts-transformer-optimize-const-enum.svg)](https://www.npmjs.com/package/ts-transformer-optimize-const-enum) ![CI Status](https://github.com/Fonger/ts-transformer-optimize-const-enum/actions/workflows/build.yml/badge.svg)
44

5-
A typescript transpiler that transform exported const enum into object literal.
5+
A typescript transformer that convert exported const enum into object literal.
66

77
This is just like the one from [@babel/preset-typescript with optimizeConstEnums: true](https://babeljs.io/docs/en/babel-preset-typescript#optimizeconstenums) but it works for typescript compiler.
88

@@ -55,7 +55,7 @@ export var MyEnum;
5555
})(MyEnum || (MyEnum = {}));
5656
```
5757

58-
which is ugly and waste a lot of bytes. Not only can't you take advantage of enum inlining, but it also wastes a lot of bytes. That's why this transform existed.
58+
Not only can't you take advantage of enum inlining, but it also wastes a lot of bytes. That's the reason why this transform is made.
5959

6060
# Installation
6161

@@ -141,7 +141,6 @@ export default {
141141
# Caveats
142142

143143
Currently, only immediate export const enum works. For example:
144-
This will be fixed in later version.
145144

146145
```ts
147146
// The following works
@@ -151,3 +150,5 @@ export const enum WorkingEnum {}
151150
const enum FailingEnum {}
152151
export FailEnum;
153152
```
153+
154+
This may be fixed in future release.

0 commit comments

Comments
 (0)