Skip to content

fix(types): Updating searchoptions with explain attribute #1415

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.

Sign up for GitHub

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

Merged
Haroenv merged 2 commits into from
Jul 18, 2022
Merged

fix(types): Updating searchoptions with explain attribute #1415

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e662b8
feat(client-search): Updating searchoptions type to include explain a…
cdhawke Jul 18, 2022
c0a9119
feat(client-search): pr feedback
cdhawke Jul 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/client-search/src/types/SearchOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,4 +373,9 @@ export type SearchOptions = {
* Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
*/
readonly queryLanguages?: readonly string[];

/**
* Enriches the API’s response with meta-information as to how the query was processed.
*/
readonly explain?: readonly string[];
};