refactor: improve typing of sorting in facetGetters/category.vue #1080
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
sethidden
commented
May 31, 2022
| import type { UseFacetSearchResult } from '~/modules/catalog/category/composables/useFacet/useFacet'; | ||
|
|
||
| export interface FacetsGetters { | ||
| getSortOptions: (searchData: UseFacetSearchResult) => SortingModel; |
There was a problem hiding this comment.
Previously the type here was AgnosticSort which turned out to be completely different at runtime. TypeScript didn't report an error since the searchData argument was any.
sethidden
commented
May 31, 2022
| }; | ||
| }; | ||
|
|
||
| const getProducts = (searchData): ProductInterface[] => { |
There was a problem hiding this comment.
I inlined the methods into the exported asserted interface since I didn't want to duplicate the typedefs
sethidden
commented
May 31, 2022
| @@ -1,3 +1,13 @@ | |||
| export interface SortingModel { | |||
There was a problem hiding this comment.
SortingModel as to avoid having "SortingOptions" and "SortingOption" interfaces with similar names
M2-645 related to M2-524 since it removes AgnosticSort
sethidden
force-pushed
the
M2-645-fix-facet-getters-category-sorting
branch
from
9f7d1fc to
68b0ba7
Compare
Frodigo
approved these changes
May 31, 2022
bartoszherba
approved these changes
May 31, 2022
| } as AgnosticSort; | ||
| } | ||
| options: searchData.data.availableSortingOptions, | ||
| selected: searchData.input.sort, |
There was a problem hiding this comment.
What if there will be no sort param?
There was a problem hiding this comment.
CategoryNavbar will not show any sort option. This will only happen if someone puts a sort id that doesn't exist into the url.
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.
Fix issue where AgnosticSort was totally different type than what would appear at runtime