Skip to main content

Interface: TFunction

i18next/src.TFunction

Callable

TFunction

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

Type parameters

NameType
TResultextends TFunctionResult = string
TKeysextends TFunctionKeys = string
TInterpolationMapextends object = StringMap

Parameters

NameType
keyTKeys | TKeys[]

Returns

TResult

Defined in

node_modules/i18next/index.d.ts:744

TFunction

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

Type parameters

NameType
TResultextends TFunctionResult = TFunctionDetailedResult<object>
TKeysextends TFunctionKeys = string
TInterpolationMapextends object = StringMap

Parameters

NameType
keyTKeys | 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

NameType
TResultextends TFunctionResult = TFunctionDetailedResult<string>
TKeysextends TFunctionKeys = string
TInterpolationMapextends object = StringMap

Parameters

NameType
keyTKeys | 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

NameType
TResultextends TFunctionResult = object
TKeysextends TFunctionKeys = string
TInterpolationMapextends object = StringMap

Parameters

NameType
keyTKeys | 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

NameType
TResultextends TFunctionResult = string
TKeysextends TFunctionKeys = string
TInterpolationMapextends object = StringMap

Parameters

NameType
keyTKeys | 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

NameType
TResultextends TFunctionResult = string
TKeysextends TFunctionKeys = string
TInterpolationMapextends object = StringMap

Parameters

NameType
keyTKeys | TKeys[]
defaultValue?string
options?string | TOptions<TInterpolationMap>

Returns

TResult

Defined in

node_modules/i18next/index.d.ts:784