Split isFulfilledData into isFulfilledBarData and isFulfilledLineData to allow WhitespaceData with extra properties
#1579
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
SlicedSilver
reviewed
May 7, 2024
| export function isFulfilledLineData<HorzScaleItem, T extends SeriesDataItemTypeMap<HorzScaleItem>[SeriesType]>( | ||
| data: T | ||
| ): data is Extract<T, BarData<HorzScaleItem> | LineData<HorzScaleItem> | HistogramData<HorzScaleItem>> { | ||
| return (data as Partial<LineData<HorzScaleItem>>).value !== undefined; | ||
| } | ||
|
|
There was a problem hiding this comment.
Perhaps we can add this:
export function isFulfilledData<HorzScaleItem, T extends SeriesDataItemTypeMap<HorzScaleItem>[SeriesType]>(
data: T
): data is Extract<T, BarData<HorzScaleItem> | LineData<HorzScaleItem> | HistogramData<HorzScaleItem>> {
return isFulfilledBarData(data) || isFulfilledLineData(data);
}and then undo the changes in chart-api.ts
There was a problem hiding this comment.
Done. I just noticed too, the data in _convertMouseParams is actually generated, meaning this assert is not for user input, so it's kinda unrelated to the pr.
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.
Type of PR: enhancement
PR checklist:
valueand notopen#1526Overview of change:
isFulfilledDatawas used to validate bothOhlcDataandSingleValueData, but based on different keys. This will cause a false assertion to be thrown when validWhitespaceDatais passed but also includes extra keys which cause it to be considered to be "fulfilled" but for the other series type. Also, this validation only occurs in development.This PR introduces
isFulfilledBarDataforOhlcData, andisFulfilledLineDataforSingleValueData. Specifically only considering the propertiesopenvsvalueinstead of either being present.Is there anything you'd like reviewers to focus on?
In the function
_convertMouseParams, instead of callingisFulfilled*Datadirectly, it could reuse the method from before.getChecker(seriesType)(data). AlsoisFulfilledDatacould be removed and merged intocheckBarItem/checkLineItemand return a boolean so_convertMouseParamscan be asserted the same. This seemed beyond the initial intention, let me know.