[algoliasearch] Search Response made generic
#33111
Conversation
Response made generic to allow better linting on the items of the `Reponse`
|
@neryortez Thank you for submitting this PR! 🔔 @CBaptiste @Haroenv @aherve @samouss @keichinger - please review this PR in the next few days. Be sure to explicitly select If no reviewer appears after a week, a DefinitelyTyped maintainer will review the PR instead. |
| @@ -1842,8 +1843,8 @@ declare namespace algoliasearch { | |||
| cursor?: string; | |||
| } | |||
|
|
|||
| interface MultiResponse { | |||
| results: Response[]; | |||
| interface MultiResponse<T=any> { | |||
There was a problem hiding this comment.
The signature of the function is not helpful when we target different indices. The type of the record is different in most cases. With this signature the response only contain records of the same type.
There was a problem hiding this comment.
I don't think this is a particular problem since you could simply define a union type as T, like in this example:
There was a problem hiding this comment.
@keichinger is right. Either way, if you just have too many types, you can also leave blank like before:
client.search(...)
The T type is optional.
There was a problem hiding this comment.
Yep, but you have to use a type guard to safely access your hit from the response. What I meant with my comment is: with this signature the response is not tightly coupled to a specific type which is the case with the single query signature.
There was a problem hiding this comment.
Yes it’s better than nothing.
typescript-bot
added
Owner Approved
|
A definition owner has approved this PR ⭐️. A maintainer will merge this PR shortly. If it shouldn't be merged yet, please leave a comment saying so and we'll wait. Thank you for your contribution to DefinitelyTyped! |
|
I just published |
This is to allow better linting on the
hitsof theReponseobjectPlease fill in this template.
npm test.)npm run lint package-name(ortscif notslint.jsonis present).If changing an existing definition:
tslint.jsoncontaining{ "extends": "dtslint/dt.json" }.