refactor: transform overlay types from interface to type #2675
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
|
♻️ PR Preview 29651c8 has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
|
♻️ PR Preview 29651c8 has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
|
Kudos, SonarCloud Quality Gate passed!
|
tbouffard
approved these changes
May 11, 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.
This pull request proposes a change to the Overlay types.
Previously, these types were defined as
interface. The changes suggests moving them totypealiases, aligning with TypeScript's philosophy. This change does not affect the API contract and is aimed at providing a better match to the intended usage of the structures, and a consistent declaration with theStyleUpdatetype.Notes
1st proposed in #2673
According to the TypeScript documentation on "Differences Between Type Aliases and Interfaces", the main distinction is that types cannot be extended.
By using
typealiases instead ofinterface, we ensure that the Overlay types are appropriate for their purpose, as they are not intended to have methods.