i18next 22.4.1 → 22.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/package.json +1 -1
- package/index.d.ts +61 -20
- package/package.json +1 -1
package/dist/esm/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"module","version":"22.4.
|
|
1
|
+
{"type":"module","version":"22.4.3"}
|
package/index.d.ts
CHANGED
|
@@ -879,11 +879,18 @@ export type TFuncReturn<
|
|
|
879
879
|
: TDefaultResult;
|
|
880
880
|
|
|
881
881
|
export interface TFunction<
|
|
882
|
-
N extends Namespace
|
|
882
|
+
N extends Namespace = DefaultNamespace,
|
|
883
883
|
TKPrefix = undefined,
|
|
884
884
|
ActualNS extends Namespace = N extends null ? DefaultNamespace : N,
|
|
885
885
|
> {
|
|
886
886
|
// just key without options etc...
|
|
887
|
+
<
|
|
888
|
+
TKeys extends TFuncKey<N, TKPrefix> | TemplateStringsArray extends infer A ? A : never,
|
|
889
|
+
TDefaultResult extends DefaultTFuncReturn = string,
|
|
890
|
+
TInterpolationMap extends object = StringMap,
|
|
891
|
+
>(
|
|
892
|
+
key: TKeys | TKeys[],
|
|
893
|
+
): TFuncReturn<N, TKeys, TDefaultResult, TKPrefix>;
|
|
887
894
|
<
|
|
888
895
|
TKeys extends TFuncKey<PassedNS, TKPrefix> | TemplateStringsArray extends infer A ? A : never,
|
|
889
896
|
TDefaultResult extends DefaultTFuncReturn = string,
|
|
@@ -893,6 +900,43 @@ export interface TFunction<
|
|
|
893
900
|
key: TKeys | TKeys[],
|
|
894
901
|
): TFuncReturn<PassedNS, TKeys, TDefaultResult, TKPrefix>;
|
|
895
902
|
|
|
903
|
+
// with returnDetails: true, returnObjects: true and ns prop in options
|
|
904
|
+
<
|
|
905
|
+
TKeys extends TFuncKey<Namespace, TKPrefix> | TemplateStringsArray extends infer A ? A : never,
|
|
906
|
+
TDefaultResult extends DefaultTFuncReturnWithObject = object,
|
|
907
|
+
TInterpolationMap extends object = StringMap,
|
|
908
|
+
PassedNS extends Namespace = N extends string ? N : N extends null ? DefaultNamespace : N,
|
|
909
|
+
>(
|
|
910
|
+
key: TKeys | TKeys[],
|
|
911
|
+
options: TOptions<TInterpolationMap> & {
|
|
912
|
+
ns: PassedNS;
|
|
913
|
+
returnObjects: true;
|
|
914
|
+
returnDetails: true;
|
|
915
|
+
},
|
|
916
|
+
): TFunctionDetailedResult<TFuncReturn<ActualNS, TKeys, TDefaultResult, TKPrefix>>;
|
|
917
|
+
|
|
918
|
+
// with returnObjects: true and ns prop in options
|
|
919
|
+
<
|
|
920
|
+
TKeys extends TFuncKey<Namespace, TKPrefix> | TemplateStringsArray extends infer A ? A : never,
|
|
921
|
+
TDefaultResult extends DefaultTFuncReturnWithObject = object,
|
|
922
|
+
TInterpolationMap extends object = StringMap,
|
|
923
|
+
PassedNS extends Namespace = N extends string ? N : N extends null ? DefaultNamespace : N,
|
|
924
|
+
>(
|
|
925
|
+
key: TKeys | TKeys[],
|
|
926
|
+
options: TOptions<TInterpolationMap> & { ns: PassedNS; returnObjects: true },
|
|
927
|
+
): TFuncReturn<PassedNS, TKeys, TDefaultResult, TKPrefix>;
|
|
928
|
+
|
|
929
|
+
// with passed ns prop in options
|
|
930
|
+
<
|
|
931
|
+
TKeys extends TFuncKey<PassedNS, TKPrefix> | TemplateStringsArray extends infer A ? A : never,
|
|
932
|
+
TDefaultResult extends DefaultTFuncReturn = string,
|
|
933
|
+
TInterpolationMap extends object = StringMap,
|
|
934
|
+
PassedNS extends Namespace = N extends string ? N : N extends null ? DefaultNamespace : N,
|
|
935
|
+
>(
|
|
936
|
+
key: TKeys | TKeys[],
|
|
937
|
+
options: TOptions<TInterpolationMap> & { ns: PassedNS },
|
|
938
|
+
): TFuncReturn<PassedNS, TKeys, TDefaultResult, TKPrefix>;
|
|
939
|
+
|
|
896
940
|
// with returnDetails: true, returnObjects: true
|
|
897
941
|
<
|
|
898
942
|
TKeys extends TFuncKey<ActualNS, TKPrefix> | TemplateStringsArray extends infer A ? A : never,
|
|
@@ -923,31 +967,28 @@ export interface TFunction<
|
|
|
923
967
|
options: TOptions<TInterpolationMap> & { returnObjects: true },
|
|
924
968
|
): TFuncReturn<ActualNS, TKeys, TDefaultResult, TKPrefix>;
|
|
925
969
|
|
|
926
|
-
// with passed ns prop in options
|
|
927
|
-
<
|
|
928
|
-
TKeys extends TFuncKey<PassedNS, TKPrefix> | TemplateStringsArray extends infer A ? A : never,
|
|
929
|
-
TDefaultResult extends DefaultTFuncReturn = string,
|
|
930
|
-
TInterpolationMap extends object = StringMap,
|
|
931
|
-
PassedNS extends Namespace = N extends string ? N : N extends null ? DefaultNamespace : N,
|
|
932
|
-
>(
|
|
933
|
-
key: TKeys | TKeys[],
|
|
934
|
-
options: TOptions<TInterpolationMap> & { ns: PassedNS },
|
|
935
|
-
): TFuncReturn<PassedNS, TKeys, TDefaultResult, TKPrefix>;
|
|
936
|
-
|
|
937
970
|
// with options
|
|
971
|
+
// <
|
|
972
|
+
// TKeys extends TFuncKey<UsedNS, TKPrefix> | TemplateStringsArray extends infer A ? A : never,
|
|
973
|
+
// TDefaultResult extends DefaultTFuncReturn = string,
|
|
974
|
+
// TInterpolationMap extends object = StringMap,
|
|
975
|
+
// PassedNS extends Namespace = N extends string ? N : N extends null ? DefaultNamespace : N,
|
|
976
|
+
// PassedOpt extends TOptions<TInterpolationMap> = TOptions<TInterpolationMap>,
|
|
977
|
+
// UsedNS extends Namespace = Pick<PassedOpt, 'ns'> extends { ns: string }
|
|
978
|
+
// ? PassedNS
|
|
979
|
+
// : ActualNS | DefaultNamespace,
|
|
980
|
+
// >(
|
|
981
|
+
// key: TKeys | TKeys[],
|
|
982
|
+
// options: PassedOpt,
|
|
983
|
+
// ): TFuncReturn<UsedNS, TKeys, TDefaultResult, TKPrefix>;
|
|
938
984
|
<
|
|
939
|
-
TKeys extends TFuncKey<
|
|
985
|
+
TKeys extends TFuncKey<N, TKPrefix> | TemplateStringsArray extends infer A ? A : never,
|
|
940
986
|
TDefaultResult extends DefaultTFuncReturn = string,
|
|
941
987
|
TInterpolationMap extends object = StringMap,
|
|
942
|
-
PassedNS extends Namespace = N extends string ? N : N extends null ? DefaultNamespace : N,
|
|
943
|
-
PassedOpt extends TOptions<TInterpolationMap> = TOptions<TInterpolationMap>,
|
|
944
|
-
UsedNS extends Namespace = Pick<PassedOpt, 'ns'> extends { ns: string }
|
|
945
|
-
? PassedNS
|
|
946
|
-
: ActualNS | DefaultNamespace,
|
|
947
988
|
>(
|
|
948
989
|
key: TKeys | TKeys[],
|
|
949
|
-
options
|
|
950
|
-
): TFuncReturn<
|
|
990
|
+
options?: TOptions<TInterpolationMap>,
|
|
991
|
+
): TFuncReturn<N, TKeys, TDefaultResult, TKPrefix>;
|
|
951
992
|
|
|
952
993
|
// defaultValue
|
|
953
994
|
<
|