Add ability to abort search request

[neupauer]

This PR adds the ability to insert additional config into the search request, e.g., signal to abort the request.

Resolve #630

[bidoubiwa]

Hey @neupauer, thanks so much for these great contributions. A few questions.

I see that you changed the config type with Partial<Request>.

• How does this affect a typeScript user ?
• Why did you had to change the type?

[neupauer]

Hi @bidoubiwa, thanks for the feedback.

The reason for the Partial<Request> is that we do not want to provide the whole interface (Request), but only part of it.

Example:

client.getIndex("movies").search("query", {}, method, {
  // only part of Request interface, e.g., signal
  signal: controller.signal,
})

Example without Partial<T>:

client.getIndex("movies").search("query", {}, method, {
  // the whole interface is required
  cache,
  credentials,
  destination,
  headers,
  signal,
  //...
})

Partial<Request> is basically the same as the Request, but all properties are optional.

More information can be found at: Typescript | Utility Types

[bidoubiwa]

Thanks a lot for your great answers!
Could you add a test that does two searches in the following scenario

• make a search A
• make a search B
• abord A
• check if B is successful and A has been aborted

[neupauer]

@bidoubiwa Yes, sure, I updated the tests and also add some notes to the README.md

Note:
I added 4 concurent search requests (3 with signal one without) and abort only one

[bidoubiwa]

LGTM 🔥 Just asking a second eye on this to be sure @curquiza

[curquiza]

A small change in the README, otherwise, it's perfect 😁 Thanks for this really clear PR!

[curquiza]

Awesome! Thanks again!!

[bidoubiwa]

bors merge

[bors]

Build succeeded:

• Node 10 sample
• Node 12 sample
• Node 14 sample