#1198 typescript - accept templatestringsarray as TKey (#1199)

i18next · Feb 11, 2019 · 95dfee8 · 95dfee8
1 parent 52c18a1
commit 95dfee8
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 11 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -469,21 +469,12 @@ declare namespace i18next {
 
   interface WithT {
     // Expose parameterized t in the i18next interface hierarchy
-    // NOTE: duplicate of TFunction - not sure why I can't find a workable reuse pattern
-    t<
-      TResult extends string | object | Array<string | object> | undefined = string,
-      TKeys extends string = string,
-      TValues extends object = object
-    >(
-      key: TKeys | TKeys[],
-      options?: TOptions<TValues>,
-    ): TResult;
+    t: TFunction;
   }
 
-  // NOTE: somewhat duplicate of WithT.t but cannot use interface - not sure why I can't find a workable reuse pattern
   type TFunction = <
     TResult extends string | object | Array<string | object> | undefined = string,
-    TKeys extends string = string,
+    TKeys extends string | TemplateStringsArray = string,
     TValues extends object = object
   >(
     key: TKeys | TKeys[],

diff --git a/test/typescript/t.tfunction.test.ts b/test/typescript/t.tfunction.test.ts
@@ -7,12 +7,14 @@ import i18next from 'i18next';
 function childrenNamespacesConsumer(t: i18next.TFunction, i18n: i18next.i18n) {
   // sanity first - tests from i18next t.test
   const is: string = i18n.t('friend'); // same as <string>
+  const is2: string = i18n.t`friend`; // same as <string>
   const io: object = i18n.t<object>('friend');
   const isa: string[] = i18n.t<string[]>('friend');
   const ioa: object[] = i18n.t<object[]>('friend');
 
   // (failing) now try t provided by NamespacesConsumer
   const s: string = t('friend'); // same as <string>
+  const s2: string = t`friend`;
   const o: object = t<object>('friend');
   const sa: string[] = t<string[]>('friend');
   const oa: object[] = t<object[]>('friend');

diff --git a/test/typescript/t.witht.test.ts b/test/typescript/t.witht.test.ts
@@ -73,12 +73,14 @@ i18next.t('arrayOfObjects.0.name');
 // -> "tom"
 
 i18next.t('friend');
+i18next.t`friend`;
 i18next.t(['friend', 'tree']);
 i18next.t('friend', { myVar: 'someValue' });
 i18next.t(['friend', 'tree'], { myVar: 'someValue' });
 
 // various returns <string> is the default
 const s: string = i18next.t('friend'); // same as <string>
+const s2: string = i18next.t`friend`;
 const o: object = i18next.t<object>('friend');
 const sa: string[] = i18next.t<string[]>('friend');
 const oa: object[] = i18next.t<object[]>('friend');