feat(react): export InstantSearchApi
type
#5518
Merged
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.
As discussed internally, exporting the
InstantSearchApi
is handy in consumers app to make sure that types are fully consistent.As an example, there are a few unintended bugs on the dashboard search because they use their own
SearchResults
type foruseInstantSearch().results
, and they assumed that it can benull
when loading. But it doesn't, RISHooks always exposes a fallback results object.Consumer apps will now be able to rely on things like
InstantSearchApi['results']
to minimize this kind of errors.I also defaulted the generic to
UiState
so that it can be used just likeuseInstantSearch()
which is already defaulted.