fix(types): use a minimal type for transformSearchClient #2348
+14
−8
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
millotp
requested review from
shortcuts and
francoischalifour
as code owners
✅ Deploy Preview for docsearch ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
shortcuts
reviewed
Nov 12, 2024
| @@ -16,17 +15,23 @@ export type DocSearchTranslations = Partial<{ | |||
| modal: ModalTranslations; | |||
| }>; | |||
|
|
|||
| export type DocSearchTransformClient = { | |||
There was a problem hiding this comment.
Suggested change
| export type DocSearchTransformClient = { | |
| // The interface that describes the minimal implementation required for the algoliasearch client, when using the [`transformSearchClient`](https://docsearch.algolia.com/docs/api/#transformsearchclient) option | |
| export type DocSearchTransformClient = { |
wdyt?
we also need to update the definition here https://docsearch.algolia.com/docs/api/#transformsearchclient
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.
The
transformSearchClienttype has change in the last release (#2326) and is breaking in some situation.To help with the migration, we can expose a new type that is the bare minimum needed by docsearch.