fix(): Derive enum types correctly when defined as an array #2615 #2647
+45
−7
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
If an enum property is decorated with `isArray: true`, its type should be derived from the type of the enum item, rather than as an `array`.
IodizedGabe
commented
Oct 3, 2023
| @@ -42,21 +48,36 @@ describe('SchemaObjectFactory', () => { | |||
| class Person { | |||
| @ApiProperty({ enum: Role, enumName: 'Role' }) | |||
| role: Role; | |||
|
|
|||
| @ApiProperty({ enum: Role, enumName: 'Role', isArray: true }) | |||
| roles: Role[]; | |||
There was a problem hiding this comment.
A similar issue wasn't detected here with roles likely because role was processed first, where it isn't defined as an array.
IodizedGabe
commented
Oct 3, 2023
| groups: Group[]; | ||
|
|
||
| @ApiProperty({ enum: Ranking, enumName: 'Ranking', isArray: true }) | ||
| rankings: Ranking[]; |
There was a problem hiding this comment.
Also check that number-based enums retain the correct type.
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.
If an enum property is decorated with
isArray: true, its type should be derived from the type of the enum item, rather than as anarray.PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: #2615
What is the new behavior?
Enum schemas should now use the type of enum itself, regardless of whether it was declared as an array or not.
Does this PR introduce a breaking change?
Other information