Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deprecate subscribeToStateUpdates #142

Merged
merged 3 commits into from
Jul 6, 2022

Conversation

yen-tt
Copy link
Contributor

@yen-tt yen-tt commented Jul 6, 2022

deprecate subscribeToStateUpdates. Update README to provide an example for class component to use AnswersHeadlessContext directly to dispatch actions and receive updates from state.

J=SLAP-2208
TEST=manual

Test that the new Searcher example with AnswersHeadlessContext works as expected. See that README look as expected.

@yen-tt yen-tt requested a review from a team as a code owner July 6, 2022 17:01
@yen-tt yen-tt changed the title deprecate subscribeToStateUpdates, update README deprecate subscribeToStateUpdates Jul 6, 2022
@coveralls
Copy link

coveralls commented Jul 6, 2022

Coverage Status

Coverage remained the same at 78.889% when pulling 6861a91 on dev/deprecate-subscribeToStateUpdates into d56dd57 on develop.

Copy link
Contributor

@oshi97 oshi97 left a comment

Choose a reason for hiding this comment

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

nice!

@yen-tt yen-tt requested a review from nmanu1 July 6, 2022 18:18
@yen-tt yen-tt merged commit 707826d into develop Jul 6, 2022
@yen-tt yen-tt deleted the dev/deprecate-subscribeToStateUpdates branch July 6, 2022 20:12
@ElemelonWind ElemelonWind mentioned this pull request Jul 19, 2022
ElemelonWind added a commit that referenced this pull request Jul 19, 2022
## Version 1.3.0
`@yext/answers-headless-react` is now `@yext/search-headless-react`!  This means that much of the `answers` terminology is now deprecated and have been replaced by new `search` terms.
### Changes
- The following identifiers were renamed in (#143):
  - `AnswersHeadlessContext` → `SearchHeadlessContext`
  - `AnswersActions` → `SearchActions`
  - `AnswersUtilities` → `SearchUtilities`
  - `useAnswersActions` → `useSearchActions`
  - `useAnswersState` → `useSearchState`
  - `useAnswersUtilities` → `useSearchUtilities`
  - `AnswersHeadlessProvider` → `SearchHeadlessProvider`
- Additionally, direct exports from what was previously `@yext/answers-headless` have been replaced by their `@yext/search-headless` counterparts:
   - `answersUtilities` → `searchUtilities`
   - `provideAnswersHeadless` → `provideHeadless`
   - `AnswersHeadless` → `SearchHeadless`
   - `AnswersConfig` → `SearchConfig`
   - `AnswersConfigWithToken` → `SearchConfigWithToken`
   - `AnswersConfigWithApiKey` → `SearchConfigWithApiKey`
   - `AnswersCore` → `SearchCore`
   - `AnswersError` → `SearchError`
   - `AnswersRequest` → `SearchRequest`
   - `BaseAnswersConfig` → `BaseSearchConfig`
- Finally, `subscribeToStateUpdates` was deprecated in (#142)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants