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

fix!: Search API functions how take query as a parameter #29

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

joerideg
Copy link
Contributor

The query to call the APIs with is a very dynamic (as in it changes a lot) value, as opposed to most of the other options which are more static. This change allows callers to call the function with the query as string, separate from the other options. It also allows for cleaner typing in consuming libraries with ProductSearchOptions as opposed to Omit<ProductSearchOptions, 'q'> when the query comes form some usually user generated state.

BREAKING CHANGE: productSearch, bestseller, contentSearch, categorySearch and autoSuggest parameters have changed.

The query to call the APIs with is a very dynamic (as in it changes a lot) value, as opposed to most
of the other options which are more static. This change allows callers to call the function with the
query as string, separate from the other options. It also allows for cleaner typing in consuming
libraries with `ProductSearchOptions` as opposed to `Omit<ProductSearchOptions, 'q'>` when the query
comes form some usually user generated state.

BREAKING CHANGE: `productSearch`, `bestseller`, `contentSearch`, `categorySearch` and `autoSuggest`
parameters have changed.
@joerideg joerideg merged commit 07e122e into main Oct 31, 2024
6 checks passed
@joerideg joerideg deleted the search-options branch October 31, 2024 17:54
@joerideg
Copy link
Contributor Author

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants