-
Notifications
You must be signed in to change notification settings - Fork 12
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
feat(javascript): provide browseObjects
, browseRules
and browseSynonyms
helper methods
#887
Conversation
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
5e2a1da
to
c59ed0b
Compare
c59ed0b
to
1339815
Compare
createIterablePromise
helperbrowseObjects
, browseRules
and browseSynonyms
helper methods
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, minor comments 👍🏻
NB: the "how to test" part of the PR desc is there to help the reviewer, please put actual test command to run and/or repro
...ts/algoliasearch-client-javascript/packages/client-common/src/types/CreateIterablePromise.ts
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good and I'm ok with the way it's done as we already discussed. I'll let someone else having a look on the typescript side of things ;)
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-601
Motivations:
(See previous motivations in the edit PR section)
We initially thought methods like
browseObjects
were ops related, but I discovered it was pretty used in some codebases, like 3 times in the Crawler.The goal of this PR is to import the 3
browse*
methods that were available in the version, to ease the user journey of iterating over API calls.Changes included:
createRetryablePromise
logic to a more genericcreateIterablePromise
@algolia/client-common
package as an alternative for users to do whatever they want with it🧪 Test
yarn docker playground javascript search
orcd cd playground/javascript/node/ && yarn start:search