Use string union types instead of enums for better TypeScript compatibility with public config file type #322
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
G-Rath
approved these changes
Dec 1, 2022
bmish
force-pushed
the
array-enum-types
branch
from
93ae3be
to
5fa092a
Compare
bmish
changed the title
bmish
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This allows the user to use either the enums (available in ESM / when using this type internally) or just the plain string values (especially in CJS config files) without encountering TypeScript errors.
Fixes #321.
This also fixes the ability to use auto-complete on these types.
Website that suggests this solution: https://bobbyhadz.com/blog/typescript-convert-enum-to-union