-
Notifications
You must be signed in to change notification settings - Fork 103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Export enums as const #726
Merged
Merged
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
AndrewFossAWS
approved these changes
Mar 27, 2023
Are there any backwards compatibility concerns around this? |
syall
reviewed
Mar 28, 2023
...ypescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/EnumGenerator.java
Outdated
Show resolved
Hide resolved
bb216f2
to
20db8d7
Compare
I added the type export to allow for using these generated consts as types. |
kuhe
approved these changes
Mar 28, 2023
In the example, it shows a double export of export const /*enum*/ Suit = { // <- Suit export 1
club: "club",
diamond: "diamond",
heart: "heart",
spade: "spade",
} as const;
export type Suit = typeof Suit[keyof typeof Suit]; // <- Suit export 2 In TS playground, the output of export declare const /*enum*/ Suit: {
readonly club: "club";
readonly diamond: "diamond";
readonly heart: "heart";
readonly spade: "spade";
};
export type Suit = typeof Suit[keyof typeof Suit]; |
kuhe
approved these changes
Mar 29, 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.
Currently, enums as generated as the following:
This results in the following JavaScript:
With this PR, enums are now generated as the following:
Which results in this JavaScript:
By exporting the additional
type
, compatibility is preserved for any consumers that are using the existing enums as types.With the tsconfig
removeComments
setting set totrue
, the in-line/*enum*/
comment will be excluded from the transpiled JavaScript.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.