Remove const enum and add ErrorValue in index.d.ts #1317
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Using
const enumin .d.ts files breaks compilation with--isolatedModules. Instead, normalenums have been used where a corresponding object exists at runtime.PaperSizedoes not exist at runtime, and so has been left asconst enumfor backwards compatibility.This also adds a declaration for
ErrorValuesince it exists at runtime but had no TS definition. This does result in some duplication withCellErrorValue, but changingCellErrorValueto useErrorValuewould be a breaking change.A comparable fix and explanation for the problem with using
const enumcan be found at chalk/chalk#296, and some further explanation at https://ncjamieson.com/dont-export-const-enums/ and this comment.Test plan
I created a small project to test this while making changes. Example file:
Before this PR:
isolatedModules: falseisolatedModules: trueWith this PR:
isolatedModules: falseisolatedModules: true