BREAKING(front_matter): deprecate Format enum, use union type instead #3641
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
lino-levan
approved these changes
Sep 17, 2023
iuioiua
reviewed
Oct 4, 2023
| MAP_FORMAT_TO_EXTRACTOR_RX, | ||
| MAP_FORMAT_TO_RECOGNIZER_RX, | ||
| } from "./_formats.ts"; | ||
|
|
||
| type Format = "yaml" | "toml" | "json" | "unknown"; |
There was a problem hiding this comment.
Nice catch, I would think so.
There was a problem hiding this comment.
The name 'Format' is currently exported as enum value, which this PR deprecates. I think exporting this 'Format' in this PR could break typing of the user's code.
How about using literal type ("yaml" | "toml" | "json" | "unknown") directly in public interfaces?
bartlomieju
approved these changes
Oct 5, 2023
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.
part of #3601 #3489
This PR deprecates
Formatenum, and use the union type"yaml" | "toml" | "json" | "unknown"instead forformatparameters.