Add rankingScore and rankingScoreDetails types #1537
Conversation
| _rankingScoreDetails?: Record<string, any> | ||
| } | ||
|
|
||
| export type RakingScoreDetails = { |
There was a problem hiding this comment.
Is there any way to add comments to these types, to make them highlight the IDEs of people using it?
There was a problem hiding this comment.
Yes, I realised I forgot to use RankingScoreDetails hehe. But to answer your question this is how IDe works w/ typescript types.
By clicking on go to type definition you'll be redirection to the RankingScoreDetails type.
Now, I can add a comment like this:
Which would appear like that if I hover over the type (see last line of second screen):
|
|
||
| const hit = response.hits[0] | ||
|
|
||
| expect(response).toHaveProperty('hits', expect.any(Array)) |
There was a problem hiding this comment.
This assertion is not valid since you'll have a broken code anyway. In the line before you ensure you're taking the first item from an array :)
There was a problem hiding this comment.
I'm not asserting hit but response. Not sure why it's broken
There was a problem hiding this comment.
hits will always be an array, that's my point. Otherwise you'll have an exception!
There was a problem hiding this comment.
In your assertion, you're telling that you expect the hits key to be an array. And that will never fail.
There was a problem hiding this comment.
Oh yes, it's a test that tests Meilisearch not my SDK haha. It's a copy paste from other tests I can remove it
Related to:
issue: meilisearch/meilisearch#3771
spec: meilisearch/specifications#252
What does this PR do?
showRankingScoreandshowRankingScoreDetails_rankingScoreand_rankingScoreDetailsin the returned hits depending on the enabled features