fix(types): FormatFunction should allow any value inside options para…

…meter (fixes #2074)
i18next · Dec 6, 2023 · 19fa49a · 19fa49a
1 parent 7b04248
commit 19fa49a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/test/typescript/format.test.ts b/test/typescript/format.test.ts
@@ -0,0 +1,9 @@
+import { FormatFunction } from 'i18next';
+
+export const customFormatFunction: FormatFunction = (value, _, lng, options) => {
+  const passedOptions = options?.formatParams?.[options.interpolationkey] || {};
+
+  // All keys should can be read from options without any error
+  const randomParameter = options?.random;
+  return '';
+};
diff --git a/typescript/options.d.ts b/typescript/options.d.ts
@@ -138,7 +138,7 @@ export type FormatFunction = (
   value: any,
   format?: string,
   lng?: string,
-  options?: InterpolationOptions & $Dictionary,
+  options?: InterpolationOptions & $Dictionary<any>,
 ) => string;
 
 export interface InterpolationOptions {