Module: i18next/src

Classes

• InternationalizationHandler

Interfaces

• HMROptions
• I18nextFormatters
• InternationalizationClientOptions
• InternationalizationContext
• InternationalizationOptions
• LocalizedInteractionReplyOptions
• LocalizedMessageOptions
• PartialLocalizedInteractionReplyOptions
• PartialLocalizedMessageOptions
• TFunction

Type Aliases

ChannelTarget

Ƭ ChannelTarget: Message | DiscordChannel

Defined in

projects/plugins/packages/i18next/src/lib/types.ts:179

---

DiscordChannel

Ƭ DiscordChannel: TextBasedDiscordChannel | StoreChannel | StageChannel | VoiceChannel

Defined in

projects/plugins/packages/i18next/src/lib/types.ts:129

---

DynamicOptions

Ƭ Private DynamicOptions<T>: (namespaces: string[], languages: string[]) => T

Type parameters

Name	Type
T	extends InitOptions

Type declaration

▸ Private (namespaces, languages): T

Parameters

Name	Type
namespaces	string[]
languages	string[]

Returns

T

Defined in

projects/plugins/packages/i18next/src/lib/types.ts:53

---

StringMap

Ƭ StringMap: Object

Index signature

▪ [key: string]: any

Defined in

node_modules/i18next/index.d.ts:694

---

TFunctionKeys

Ƭ TFunctionKeys: string | TemplateStringsArray

Defined in

node_modules/i18next/index.d.ts:751

---

TFunctionResult

Ƭ TFunctionResult: string | object | TFunctionDetailedResult | (string | object)[] | undefined | null

Defined in

node_modules/i18next/index.d.ts:744

---

TOptions

Ƭ TOptions<TInterpolationMap>: TOptionsBase & TInterpolationMap

Type parameters

Name	Type
TInterpolationMap	extends object = StringMap

Defined in

node_modules/i18next/index.d.ts:699

---

Target

Ƭ Target: BaseCommandInteraction | ChannelTarget | Guild | MessageComponentInteraction

Defined in

projects/plugins/packages/i18next/src/lib/types.ts:180

---

TextBasedDiscordChannel

Ƭ TextBasedDiscordChannel: Message["channel"]

Defined in

projects/plugins/packages/i18next/src/lib/types.ts:128

Functions

editLocalized

▸ editLocalized<TKeys>(target, keys): Promise<Message>

Type parameters

Name	Type
TKeys	extends TFunctionKeys = string

Parameters

Name	Type	Description
target	Message<boolean>
keys	TKeys | TKeys[]

Returns

Promise<Message>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:264

▸ editLocalized<TKeys, TInterpolationMap>(target, options): Promise<Message>

Type parameters

Name	Type
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends NonNullObject = StringMap

Parameters

Name	Type	Description
target	Message<boolean>
options	LocalizedMessageOptions<TKeys, TInterpolationMap>

Returns

Promise<Message>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:289

▸ editLocalized<TKeys>(target, keys): Promise<ReturnType<BaseCommandInteraction | MessageComponentInteraction["editReply"]>>

Type parameters

Name	Type
TKeys	extends TFunctionKeys = string

Parameters

Name	Type	Description
target	BaseCommandInteraction<CacheType> | MessageComponentInteraction<CacheType>
keys	TKeys | TKeys[]	-

Returns

Promise<ReturnType<BaseCommandInteraction | MessageComponentInteraction["editReply"]>>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:305

▸ editLocalized<TKeys, TInterpolationMap>(target, options): Promise<ReturnType<BaseCommandInteraction | MessageComponentInteraction["editReply"]>>

Type parameters

Name	Type
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends NonNullObject = StringMap

Parameters

Name	Type	Description
target	BaseCommandInteraction<CacheType> | MessageComponentInteraction<CacheType>
options	LocalizedInteractionReplyOptions<TKeys, TInterpolationMap>

Returns

Promise<ReturnType<BaseCommandInteraction | MessageComponentInteraction["editReply"]>>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:333

---

fetchLanguage

▸ fetchLanguage(target): Promise<string>

Parameters

Name	Type	Description
target	Target

Returns

Promise<string>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:35

---

fetchT

▸ fetchT(target): Promise<TFunction>

Parameters

Name	Type	Description
target	Target

Returns

Promise<TFunction>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:72

---

replyLocalized

▸ replyLocalized<TKeys>(target, keys): Promise<Message>

Type parameters

Name	Type
TKeys	extends TFunctionKeys = string

Parameters

Name	Type	Description
target	Message<boolean>
keys	TKeys | TKeys[]

Returns

Promise<Message>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:152

▸ replyLocalized<TKeys, TInterpolationMap>(target, options): Promise<Message>

Type parameters

Name	Type
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends NonNullObject = StringMap

Parameters

Name	Type	Description
target	Message<boolean>
options	LocalizedMessageOptions<TKeys, TInterpolationMap>

Returns

Promise<Message>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:176

▸ replyLocalized<TKeys>(target, keys): Promise<ReturnType<BaseCommandInteraction | MessageComponentInteraction["reply"]>>

Type parameters

Name	Type
TKeys	extends TFunctionKeys = string

Parameters

Name	Type	Description
target	BaseCommandInteraction<CacheType> & { reply: (options: string | MessagePayload | InteractionReplyOptions | ReplyMessageOptions) => Promise<Promise<void>> } & MessageComponentInteraction<CacheType> & { reply: (options: string | MessagePayload | InteractionReplyOptions | ReplyMessageOptions) => Promise<Promise<void>> }
keys	TKeys | TKeys[]

Returns

Promise<ReturnType<BaseCommandInteraction | MessageComponentInteraction["reply"]>>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:192

▸ replyLocalized<TKeys, TInterpolationMap>(target, options): Promise<ReturnType<BaseCommandInteraction | MessageComponentInteraction["reply"]>>

Type parameters

Name	Type
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends NonNullObject = StringMap

Parameters

Name	Type	Description
target	BaseCommandInteraction<CacheType> & { reply: (options: string | MessagePayload | InteractionReplyOptions | ReplyMessageOptions) => Promise<Promise<void>> } & MessageComponentInteraction<CacheType> & { reply: (options: string | MessagePayload | InteractionReplyOptions | ReplyMessageOptions) => Promise<Promise<void>> }
options	LocalizedInteractionReplyOptions<TKeys, TInterpolationMap>

Returns

Promise<ReturnType<BaseCommandInteraction | MessageComponentInteraction["reply"]>>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:223

---

resolveKey

▸ resolveKey<TResult, TKeys, TInterpolationMap>(target, key, options?): Promise<TResult>

Type parameters

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

Parameters

Name	Type	Description
target	Target
key	TKeys | TKeys[]
options?	TOptions<TInterpolationMap>	-

Returns

Promise<TResult>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:84

---

sendLocalized

▸ sendLocalized<TKeys>(target, keys): Promise<Message>

Type parameters

Name	Type
TKeys	extends TFunctionKeys = string

Parameters

Name	Type	Description
target	ChannelTarget
keys	TKeys | TKeys[]

Returns

Promise<Message>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:104

▸ sendLocalized<TKeys, TInterpolationMap>(target, options): Promise<Message>

Type parameters

Name	Type
TKeys	extends TFunctionKeys = string
TInterpolationMap	extends NonNullObject = StringMap

Parameters

Name	Type	Description
target	ChannelTarget
options	LocalizedMessageOptions<TKeys, TInterpolationMap>

Returns

Promise<Message>

Defined in

projects/plugins/packages/i18next/src/lib/functions.ts:128