fix(types): Allow sorting by text score #11893
Merged
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
Sorting by text score is a special case. See https://www.mongodb.com/docs/manual/reference/method/cursor.sort/#text-score-metadata-sort This fixes a type error caused by 6.3.5
vkarpov15
requested changes
Jun 5, 2022
types/query.d.ts
Outdated
| @@ -579,7 +579,7 @@ declare module 'mongoose' { | |||
| snapshot(val?: boolean): this; | |||
|
|
|||
| /** Sets the sort order. If an object is passed, values allowed are `asc`, `desc`, `ascending`, `descending`, `1`, and `-1`. */ | |||
| sort(arg?: string | { [key: string]: SortOrder } | undefined | null): this; | |||
| sort(arg?: string | { [key: string]: SortOrder } | { score: { $meta: 'textScore' } } | undefined | null): this; | |||
There was a problem hiding this comment.
The sort key doesn't necessarily have to be called score. You can also do { textScore: { $meta: 'textScore' } }, see https://thecodebarbarian.com/2014/04/10/a-nodejs-perspective-on-whats-new-in-mongodb-2-6-part-i-text-search.html .
According to https://www.mongodb.com/docs/manual/reference/operator/aggregation/meta/, { $meta: 'indexKey' } is also valid.
Maybe something like { [key: string]: { $meta: 'textScore' | 'indexKey' } } ?
There was a problem hiding this comment.
Good point about the score key. { $meta: 'indexKey' } should be valid but not for sorting, it's just for the projection I think.
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.
Summary
Sorting by text score is a special case. See https://www.mongodb.com/docs/manual/reference/method/cursor.sort/#text-score-metadata-sort
This fixes a type error caused by 6.3.5
Examples
This code fails with 6.3.5:
It used to work