improve types for getTransliterateSuggestions

Author: burhanuday

README.md

@@ -179,9 +179,11 @@ import { getTransliterateSuggestions } from "react-transliterate";
 
 const data = await getTransliterateSuggestions(
   word, // word to fetch suggestions for
-  5, // number of suggestions to fetch
-  false, // add the word as the last suggestion
-  "hi", // target language
+  {
+    numOptions: 5, // number of suggestions to fetch
+    showCurrentWordAsLastSuggestion: true, // add the word as the last suggestion
+    lang: "hi", // target language
+  },
 );
 ```
 

src/index.tsx

@@ -111,12 +111,11 @@ export const ReactTransliterate = ({
       ? maxOptions - 1
       : maxOptions;
 
-    const data = await getTransliterateSuggestions(
-      lastWord,
+    const data = await getTransliterateSuggestions(lastWord, {
       numOptions,
       showCurrentWordAsLastSuggestion,
       lang,
-    );
+    });
     setOptions(data);
   };
 

src/util/suggestions-util.ts

@@ -1,22 +1,36 @@
+import { Language } from "../types/Language";
+
+type Config = {
+  numOptions?: number;
+  showCurrentWordAsLastSuggestion?: boolean;
+  lang?: Language;
+};
+
 export const getTransliterateSuggestions = async (
-  lastWord: string,
-  numOptions = 5,
-  showCurrentWordAsLastSuggestion = false,
-  lang = "hi",
-) => {
+  word: string,
+  config?: Config,
+): Promise<string[]> => {
+  const { numOptions, showCurrentWordAsLastSuggestion, lang } = config || {
+    numOptions: 5,
+    showCurrentWordAsLastSuggestion: true,
+    lang: "hi",
+  };
   // fetch suggestion from api
-  // const url = `https://www.google.com/inputtools/request?ime=transliteration_en_${lang}&num=5&cp=0&cs=0&ie=utf-8&oe=utf-8&app=jsapi&text=${lastWord}`;
+  // const url = `https://www.google.com/inputtools/request?ime=transliteration_en_${lang}&num=5&cp=0&cs=0&ie=utf-8&oe=utf-8&app=jsapi&text=${word}`;
 
-  const url = `https://inputtools.google.com/request?text=${lastWord}&itc=${lang}-t-i0-und&num=${numOptions}&cp=0&cs=1&ie=utf-8&oe=utf-8&app=demopage`;
+  const url = `https://inputtools.google.com/request?text=${word}&itc=${lang}-t-i0-und&num=${numOptions}&cp=0&cs=1&ie=utf-8&oe=utf-8&app=demopage`;
   try {
     const res = await fetch(url);
     const data = await res.json();
     if (data && data[0] === "SUCCESS") {
       const found = showCurrentWordAsLastSuggestion
-        ? [...data[1][0][1], lastWord]
+        ? [...data[1][0][1], word]
         : data[1][0][1];
       return found;
     } else {
+      if (showCurrentWordAsLastSuggestion) {
+        return [word];
+      }
       return [];
     }
   } catch (e) {