fix: add string type to gt/lt/gte/lte type definitions #2704
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.
π Linked issue
#437
β Type of change
π Description
The
$gte
,$gt
,$lt
,$lte
operators are defined in the Typescript as only taking a number. This is in fact incorrect as they map to the standard JavaScript>=
,>
,<
,<=
operators which can handle any more types and as the test coverage shows they work perfect with strings.This fix is needed as anyone trying to use these operators with a string - such as in a common case as filtering by alpha ranges or even a sort-formatted date string - will receive Typescript errors leading them to think this is not the way to do it.
This adds the
string
type to those operators, adds test coverage to prove they work and importantly adds an example to the filtering docs showing how to use the string filtering to sort by a date which is a common situation and one the linked ticket went into.π Checklist