Interface: TFunction

i18next/src.TFunction

Callable

TFunction

▸ TFunction<TResult, TKeys, TInterpolationMap>(key): TResult

Type parameters

Name	Type
TResult	extends TFunctionResult = string
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends object = StringMap

Parameters

Name	Type
key	TKeys | TKeys[]

Returns

TResult

Defined in

node_modules/i18next/index.d.ts:744

TFunction

▸ TFunction<TResult, TKeys, TInterpolationMap>(key, options?): TResult

Type parameters

Name	Type
TResult	extends TFunctionResult = TFunctionDetailedResult<object>
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends object = StringMap

Parameters

Name	Type
key	TKeys | TKeys[]
options?	TOptionsBase & TInterpolationMap & { returnDetails: true ; returnObjects: true }

Returns

TResult

Defined in

node_modules/i18next/index.d.ts:751

TFunction

▸ TFunction<TResult, TKeys, TInterpolationMap>(key, options?): TResult

Type parameters

Name	Type
TResult	extends TFunctionResult = TFunctionDetailedResult<string>
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends object = StringMap

Parameters

Name	Type
key	TKeys | TKeys[]
options?	TOptionsBase & TInterpolationMap & { returnDetails: true }

Returns

TResult

Defined in

node_modules/i18next/index.d.ts:759

TFunction

▸ TFunction<TResult, TKeys, TInterpolationMap>(key, options?): TResult

Type parameters

Name	Type
TResult	extends TFunctionResult = object
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends object = StringMap

Parameters

Name	Type
key	TKeys | TKeys[]
options?	TOptionsBase & TInterpolationMap & { returnObjects: true }

Returns

TResult

Defined in

node_modules/i18next/index.d.ts:767

TFunction

▸ TFunction<TResult, TKeys, TInterpolationMap>(key, options?): TResult

Type parameters

Name	Type
TResult	extends TFunctionResult = string
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends object = StringMap

Parameters

Name	Type
key	TKeys | TKeys[]
options?	string | TOptions<TInterpolationMap>

Returns

TResult

Defined in

node_modules/i18next/index.d.ts:775

TFunction

▸ TFunction<TResult, TKeys, TInterpolationMap>(key, defaultValue?, options?): TResult

Type parameters

Name	Type
TResult	extends TFunctionResult = string
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends object = StringMap

Parameters

Name	Type
key	TKeys | TKeys[]
defaultValue?	string
options?	string | TOptions<TInterpolationMap>

Returns

TResult

Defined in

node_modules/i18next/index.d.ts:784