Improve type safety
authorshilangyu <xmarcinmarcin@gmail.com>
Mon, 1 Mar 2021 20:33:57 +0000 (21:33 +0100)
committershilangyu <xmarcinmarcin@gmail.com>
Mon, 1 Mar 2021 20:33:57 +0000 (21:33 +0100)
generate_translations.js
src/shared/i18next.ts

index 313e80031e8c08d5c83332310fb4dfca6152feb7..594f574c3433778551159c28cc8ae5d32369ee6c 100644 (file)
@@ -32,17 +32,17 @@ const baseLanguage = "en";
 fs.readFile(`${translationDir}${baseLanguage}.json`, "utf8", (_, fileStr) => {
   const keys = Object.keys(JSON.parse(fileStr));
 
-  const data = `import * as i18n from "i18next";
-
-type I18nKeys = 
-${keys.map(key => `  | "${key}"`).join("\n")};
+  const data = `import { i18n } from "i18next";
 
 declare module "i18next" {
-  export interface TFunction {
+  export type I18nKeys = 
+${keys.map(key => `    | "${key}"`).join("\n")};
+  
+  export interface TFunctionTyped {
     // basic usage
     <
       TResult extends TFunctionResult = string,
-      TInterpolationMap extends object = StringMap
+      TInterpolationMap extends Record<string, unknown> = StringMap
     >(
       key: I18nKeys | I18nKeys[],
       options?: TOptions<TInterpolationMap> | string
@@ -50,13 +50,17 @@ declare module "i18next" {
     // overloaded usage
     <
       TResult extends TFunctionResult = string,
-      TInterpolationMap extends object = StringMap
+      TInterpolationMap extends Record<string, unknown> = StringMap
     >(
       key: I18nKeys | I18nKeys[],
       defaultValue?: string,
       options?: TOptions<TInterpolationMap> | string
     ): TResult;
   }
+
+  export interface i18nTyped extends i18n {
+    t: TFunctionTyped;
+  }
 }
 `;
 
index 99289032e6a47dcb690052cf9d8c68e47862c486..3d3d5a1fc2dcc94ea8764b341c2cf92b04196e12 100644 (file)
@@ -1,4 +1,4 @@
-import i18next from "i18next";
+import i18next, { i18nTyped } from "i18next";
 import { getLanguage } from "./utils";
 import { en } from "./translations/en";
 import { el } from "./translations/el";
@@ -82,4 +82,6 @@ i18next.init({
   interpolation: { format },
 });
 
-export { i18next as i18n, resources };
+export const i18n = i18next as i18nTyped;
+
+export { resources };