docs: document Requester API#541
Merged
sarahdayan merged 10 commits intofeat/requester-apifrom Apr 22, 2021
Merged
Conversation
|
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 0d1d308:
|
|
|
||
| The queries to search for, with the following parameters: | ||
|
|
||
| #### `indexName` |
Contributor
There was a problem hiding this comment.
There's also type and facet now.
Co-authored-by: François Chalifour <francoischalifour@users.noreply.github.com>
francoischalifour
approved these changes
Apr 22, 2021
* feat: introduce createGetAlgoliaFacets * feat: expose RequesterParams type * refactor: use factory to create function * test: update tests * docs: update docs * fix: update implems * build: increase bundle size * refactor: keep duplicates for simplicity * style: lint * fix: apply suggestions from code review Co-authored-by: François Chalifour <francoischalifour@users.noreply.github.com> * test: better test getAlgoliaResults (#544) * test: remove unnecessary async/await keywords * test(autocomplete-js): add unit test for getAlgoliaResults * fix: remove needless async Co-authored-by: François Chalifour <francoischalifour@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This documents the Requester API in the current documentation. This will be ported over to the main docs for the stable release, but in the meantime the live docs will be up to date.
This documents the
getAlgoliaResultsandgetAlgoliaFacetsfunctions in bothautocomplete-algolia-presetandautocomplete-jswith API reference and note on usage to ensure proper batching.The PR also updates existing occurrences of the former API.
I've noticed that some of the playgrounds and Cypress tests aren't up to date. I'll take care of them in another PR.