Interface: TFunction<N, TKPrefix, ActualNS>
@sapphire/plugin-i18next.TFunction
Type parameters
Name | Type |
---|---|
N | extends Namespace = DefaultNamespace |
TKPrefix | undefined |
ActualNS | extends Namespace = N extends null ? DefaultNamespace : N |
Callable
TFunction
▸ TFunction<TKeys
, TDefaultResult
, TInterpolationMap
>(key
): TFuncReturn
<N
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Type parameters
Name | Type |
---|---|
TKeys | extends unknown |
TDefaultResult | extends DefaultTFuncReturn = string |
TInterpolationMap | extends object = StringMap |
Parameters
Name | Type |
---|---|
key | TKeys | TKeys [] |
Returns
TFuncReturn
<N
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Defined in
node_modules/i18next/index.d.ts:887
TFunction
▸ TFunction<TKeys
, TDefaultResult
, TInterpolationMap
, PassedNS
>(key
): TFuncReturn
<PassedNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Type parameters
Name | Type |
---|---|
TKeys | extends string |
TDefaultResult | extends DefaultTFuncReturn = string |
TInterpolationMap | extends object = StringMap |
PassedNS | extends Namespace <string > = N extends string ? N : N extends unknown ? "translation" : N |
Parameters
Name | Type |
---|---|
key | TKeys | TKeys [] |
Returns
TFuncReturn
<PassedNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Defined in
node_modules/i18next/index.d.ts:894
TFunction
▸ TFunction<TKeys
, TDefaultResult
, TInterpolationMap
, PassedNS
>(key
, options
): TFunctionDetailedResult
<TFuncReturn
<ActualNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>>
Type parameters
Name | Type |
---|---|
TKeys | extends string |
TDefaultResult | extends DefaultTFuncReturnWithObject = object |
TInterpolationMap | extends object = StringMap |
PassedNS | extends Namespace <string > = N extends string ? N : N extends null ? "translation" : N |
Parameters
Name | Type |
---|---|
key | TKeys | TKeys [] |
options | TOptionsBase & TInterpolationMap & { ns : PassedNS ; returnDetails : true ; returnObjects : true } |
Returns
TFunctionDetailedResult
<TFuncReturn
<ActualNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>>
Defined in
node_modules/i18next/index.d.ts:904
TFunction
▸ TFunction<TKeys
, TDefaultResult
, TInterpolationMap
, PassedNS
>(key
, options
): TFuncReturn
<PassedNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Type parameters
Name | Type |
---|---|
TKeys | extends string |
TDefaultResult | extends DefaultTFuncReturnWithObject = object |
TInterpolationMap | extends object = StringMap |
PassedNS | extends Namespace <string > = N extends string ? N : N extends null ? "translation" : N |
Parameters
Name | Type |
---|---|
key | TKeys | TKeys [] |
options | TOptionsBase & TInterpolationMap & { ns : PassedNS ; returnObjects : true } |
Returns
TFuncReturn
<PassedNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Defined in
node_modules/i18next/index.d.ts:919
TFunction
▸ TFunction<TKeys
, TDefaultResult
, TInterpolationMap
, PassedNS
>(key
, options
): TFuncReturn
<PassedNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Type parameters
Name | Type |
---|---|
TKeys | extends string |
TDefaultResult | extends DefaultTFuncReturn = string |
TInterpolationMap | extends object = StringMap |
PassedNS | extends Namespace <string > = N extends string ? N : N extends null ? "translation" : N |
Parameters
Name | Type |
---|---|
key | TKeys | TKeys [] |
options | TOptionsBase & TInterpolationMap & { ns : PassedNS } |
Returns
TFuncReturn
<PassedNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Defined in
node_modules/i18next/index.d.ts:930
TFunction
▸ TFunction<TKeys
, TDefaultResult
, TInterpolationMap
>(key
, options
): TFunctionDetailedResult
<TFuncReturn
<ActualNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>>
Type parameters
Name | Type |
---|---|
TKeys | extends unknown |
TDefaultResult | extends DefaultTFuncReturnWithObject = object |
TInterpolationMap | extends object = StringMap |
Parameters
Name | Type |
---|---|
key | TKeys | TKeys [] |
options | TOptionsBase & TInterpolationMap & { returnDetails : true ; returnObjects : true } |
Returns
TFunctionDetailedResult
<TFuncReturn
<ActualNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>>
Defined in
node_modules/i18next/index.d.ts:941
TFunction
▸ TFunction<TKeys
, TDefaultResult
, TInterpolationMap
>(key
, options
): TFunctionDetailedResult
<TFuncReturn
<ActualNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>>
Type parameters
Name | Type |
---|---|
TKeys | extends unknown |
TDefaultResult | extends DefaultTFuncReturn = string |
TInterpolationMap | extends object = StringMap |
Parameters
Name | Type |
---|---|
key | TKeys | TKeys [] |
options | TOptionsBase & TInterpolationMap & { returnDetails : true } |
Returns
TFunctionDetailedResult
<TFuncReturn
<ActualNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>>
Defined in
node_modules/i18next/index.d.ts:951
TFunction
▸ TFunction<TKeys
, TDefaultResult
, TInterpolationMap
>(key
, options
): TFuncReturn
<ActualNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Type parameters
Name | Type |
---|---|
TKeys | extends unknown |
TDefaultResult | extends DefaultTFuncReturnWithObject = object |
TInterpolationMap | extends object = StringMap |
Parameters
Name | Type |
---|---|
key | TKeys | TKeys [] |
options | TOptionsBase & TInterpolationMap & { returnObjects : true } |
Returns
TFuncReturn
<ActualNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Defined in
node_modules/i18next/index.d.ts:961
TFunction
▸ TFunction<TKeys
, TDefaultResult
, TInterpolationMap
, PassedNS
, PassedOpt
, UsedNS
>(key
, options
): TFuncReturn
<UsedNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Type parameters
Name | Type |
---|---|
TKeys | extends string |
TDefaultResult | extends DefaultTFuncReturn = string |
TInterpolationMap | extends object = StringMap |
PassedNS | extends Namespace <string > = N extends string ? N : N extends null ? "translation" : N |
PassedOpt | extends TOptionsBase & object = TOptions <TInterpolationMap > |
UsedNS | extends Namespace <string > = Pick <PassedOpt , "ns" > extends { ns : string } ? PassedNS : "translation" | ActualNS |
Parameters
Name | Type |
---|---|
key | TKeys | TKeys [] |
options | PassedOpt |
Returns
TFuncReturn
<UsedNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Defined in
node_modules/i18next/index.d.ts:971
TFunction
▸ TFunction<TKeys
, TDefaultResult
, TInterpolationMap
>(key
, defaultValue
, options?
): TFuncReturn
<ActualNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Type parameters
Name | Type |
---|---|
TKeys | extends unknown |
TDefaultResult | extends DefaultTFuncReturn = string |
TInterpolationMap | extends object = StringMap |
Parameters
Name | Type |
---|---|
key | TKeys | TKeys [] |
defaultValue | string |
options? | string | TOptions <TInterpolationMap > |
Returns
TFuncReturn
<ActualNS
, TKeys
, TDefaultResult
, TKPrefix
, object
>
Defined in
node_modules/i18next/index.d.ts:994
TFunction
▸ TFunction<TDefaultResult
, TInterpolationMap
>(key
, defaultValue
, options?
): TFuncReturn
<ActualNS
, string
, TDefaultResult
, TKPrefix
, object
>
Type parameters
Name | Type |
---|---|
TDefaultResult | extends DefaultTFuncReturn = string |
TInterpolationMap | extends object = StringMap |
Parameters
Name | Type |
---|---|
key | string | string [] |
defaultValue | string |
options? | string | TOptions <TInterpolationMap > |
Returns
TFuncReturn
<ActualNS
, string
, TDefaultResult
, TKPrefix
, object
>
Defined in
node_modules/i18next/index.d.ts:1003
TFunction
▸ TFunction<TDefaultResult
, TInterpolationMap
>(key
, options
): TFuncReturn
<ActualNS
, string
, TDefaultResult
, TKPrefix
, object
>
Type parameters
Name | Type |
---|---|
TDefaultResult | extends DefaultTFuncReturn = string |
TInterpolationMap | extends object = StringMap |
Parameters
Name | Type |
---|---|
key | string | string [] |
options | TOptionsBase & TInterpolationMap & { defaultValue : string } |
Returns
TFuncReturn
<ActualNS
, string
, TDefaultResult
, TKPrefix
, object
>
Defined in
node_modules/i18next/index.d.ts:1013