Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

feat(typing): Update SearchResults hits, expose optional hit typings #914

Merged
merged 4 commits into from
Aug 2, 2022

Conversation

cdhawke
Copy link
Contributor

@cdhawke cdhawke commented Jul 21, 2022

Motivation

  • Add optional typings to SearchResults hit and expose the HighlightResult RankingInfo and SnippetResult typings for use elsewhere.
  • The goal is to update the @types/react-instantsearch-core types to use the actual SearchResults from algoliasearch-helper rather than redefining their own. SearchResults + HighlightResults, etc.

@cdhawke cdhawke requested a review from Haroenv July 21, 2022 15:17
@cdhawke cdhawke self-assigned this Jul 21, 2022
@codesandbox-ci
Copy link

codesandbox-ci bot commented Jul 21, 2022

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 2e0c4a2:

Sandbox Source
javascript-helper-app Configuration
InstantSearch.js Configuration

types/algoliasearch.d.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@Haroenv Haroenv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as far as I can tell this works in InstantSearch, as they're new types mainly

@Haroenv Haroenv requested a review from dhayab July 26, 2022 07:17
@cdhawke
Copy link
Contributor Author

cdhawke commented Aug 1, 2022

@Haroenv @dhayab im not able to merge this in case you were waiting on me.

@dhayab
Copy link
Member

dhayab commented Aug 2, 2022

Sure, I'll handle that. Thanks for this contribution!

@dhayab dhayab merged commit bf4c4c6 into develop Aug 2, 2022
@dhayab dhayab deleted the feat/results-typing branch August 2, 2022 08:14
dhayab added a commit that referenced this pull request Aug 3, 2022
 * feat(typing): Update SearchResults hits, expose optional hit typings (#914) bf4c4c6
dhayab pushed a commit to algolia/instantsearch that referenced this pull request Jul 10, 2023
dhayab added a commit to algolia/instantsearch that referenced this pull request Jul 10, 2023
 * feat(typing): Update SearchResults hits, expose optional hit typings (algolia/algoliasearch-helper-js#914) algolia/algoliasearch-helper-js@9fdfe99
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants