feat: improve IPerfumeData types and usage #267
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 (typeof metric[key] === 'number') { | ||
| metric[key] = roundByFour(metric[key]); | ||
| const roundNumericProperties = (data: IPerfumeData): IPerfumeData => { | ||
| if (typeof data === 'number') { |
There was a problem hiding this comment.
Note that this if statement is designed to replicate the original behavior, if I get it right. It's unclear why IPerfumeData values of type number are not rounded, unlike objects.
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.
Motivation
I noticed that the
IPerfumeDatatype was incomplete. There was some usage ofany, and the type did not declare all possible properties.This PR aims to improve this to ease the usage of the library.
Changes
IPerfumeStorageEstimate.IPerfumeDatawithIPerfumeStorageEstimate,IPerfumeDataConsumption, andIPerformanceEntry.anyusage with specific types.logDatato comply with ESLint and type usage. A functional approach that does not modify the type passed as a parameter is preferable.Tests
One test is failing, similar to when I ran the test suite on the main branch. Therefore, I assume that the tests are currently broken, and providing the exact same results validates the refactoring.
I did not provide an additional test since the PR introduces no new functional features.