fix(Search, Typescript): Allow creating GSearchRequest without 'q' (but requiring 'filters')#777
Conversation
…ut requiring 'filters')
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #777 +/- ##
=======================================
Coverage 95.79% 95.79%
=======================================
Files 86 86
Lines 1759 1759
Branches 294 294
=======================================
Hits 1685 1685
Misses 73 73
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| // @ts-expect-error `filters` should require at least one element | ||
| const requireOneFilter: query.GSearchRequest = { | ||
| filters: [], | ||
| }; | ||
| expect(requireOneFilter).toBeDefined(); |
There was a problem hiding this comment.
I don't understand what this is supposed to be testing. When is requireOneFilter expected to be undefined? Is this to produce a typescript error if GSearchRequest is changed in a way that's incompatible with having an empty filters array?
There was a problem hiding this comment.
Yes, this is only a Typescript assertion, the // @ts-expect-error is ensuring that filters: [] is not acceptable.
The expect(requireOneFilter).toBeDefined() is to avoid the unused variable error.
There was a problem hiding this comment.
Ohhhh, I see now, thanks!
https://docs.globus.org/api/search/reference/post_query/#gsearchrequest