Skip to main content

Interface: InternationalizationOptions

i18next/src.InternationalizationOptions

The options used in InternationalizationHandler.

since 1.0.0

Properties

backend

Optional backend: Options

The options passed to backend in i18next.init.

since 1.0.0

Defined in

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


defaultLanguageDirectory

Optional defaultLanguageDirectory: string

The directory in which "i18next-fs-backend" should search for files.

default rootDirectory/language

since 1.0.0

Defined in

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


defaultMissingKey

Optional defaultMissingKey: string

The default value to be used if a specific language key isn't found. Defaults to "default:default".

since 1.0.0

Defined in

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


defaultNS

Optional defaultNS: string

The default NS that is prefixed to all keys that don't specify it. Defaults to "default".

since 1.0.0

Defined in

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


defaultName

Optional defaultName: string

Used as the default 2nd to last fallback locale if no other is found. It's only followed by "en-US".

since 1.0.0

Defined in

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


formatters

Optional formatters: I18nextFormatters[]

Array of formatters to add to i18n.

since 2.0.0

default []

Defined in

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


hmr

Optional hmr: HMROptions

Reload languages and namespaces when updating the languages directory.

since 2.2.0

Defined in

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


i18next

Optional i18next: InitOptions | DynamicOptions<InitOptions>

The options passed to i18next.init.

since 1.0.0

Defined in

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

Methods

fetchLanguage

Optional fetchLanguage(context): Awaitable<null | string>

A function that is to be used to retrieve the language for the current context. Context exists of a {@link Guild guild}, a channel and a {@link User user}.

If this is not set, then the language will always be the default language.

This will be inserted for InternationalizationHandler.fetchLanguage.

since 2.0.0

default () => InternationalizationOptions.defaultName

Parameters

NameType
contextInternationalizationContext

Returns

Awaitable<null | string>

Defined in

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