feat(ts): add decompoundQuery (#1240)

* feat(ts): add decompoundQuery A new setting and parameter as an add-on to [decompoundedAttributes](https://www.algolia.com/doc/api-reference/api-parameters/decompoundedAttributes/?client=javascript) * unrelated to the setting!
algolia · Jan 15, 2021 · 446c9a0 · 446c9a0
1 parent 608f2ec
commit 446c9a0
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/packages/client-search/src/types/SearchOptions.ts b/packages/client-search/src/types/SearchOptions.ts
@@ -334,4 +334,12 @@ export type SearchOptions = {
    * Engine's default: true
    */
   readonly enableABTest?: boolean;
+
+  /**
+   * Enable word segmentation (also called decompounding) at query time for
+   * compatible languages. For example, this turns the Dutch query
+   * "spaanplaatbehang" into "spaan plaat behang" to retrieve more relevant
+   * results.
+   */
+  readonly decompoundQuery?: boolean;
 };
diff --git a/packages/client-search/src/types/Settings.ts b/packages/client-search/src/types/Settings.ts
@@ -283,4 +283,12 @@ export type Settings = {
    * Custom userData that could be added to the Settings.
    */
   readonly userData?: any;
+
+  /**
+   * Enable word segmentation (also called decompounding) at query time for
+   * compatible languages. For example, this turns the Dutch query
+   * "spaanplaatbehang" into "spaan plaat behang" to retrieve more relevant
+   * results.
+   */
+  readonly decompoundQuery?: boolean;
 };