Skip to main content

Interface: InternationalizationOptions

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

The options used in InternationalizationHandler.

Since​

1.0.0

Properties​

backend?​

optional backend: Options<object>

Defined in: projects/plugins/packages/i18next/src/lib/types.ts:83

The options passed to backend in i18next.init.

Since​

1.0.0

defaultLanguageDirectory?​

optional defaultLanguageDirectory: string

Defined in: projects/plugins/packages/i18next/src/lib/types.ts:96

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

Default​

rootDirectory/language

Since​

1.0.0

defaultMissingKey?​

optional defaultMissingKey: string

Defined in: projects/plugins/packages/i18next/src/lib/types.ts:103

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

Since​

1.0.0

defaultName?​

optional defaultName: string

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

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

defaultNS?​

optional defaultNS: string

Defined in: projects/plugins/packages/i18next/src/lib/types.ts:110

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

Since​

1.0.0

fetchLanguage()?​

optional fetchLanguage: (context: InternationalizationContext) => Awaitable<null | string>

Defined in: projects/plugins/packages/i18next/src/lib/types.ts:137

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

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

This will be inserted for InternationalizationHandler.fetchLanguage.

Parameters​

ParameterType
contextInternationalizationContext

Returns​

Awaitable<null | string>

Since​

2.0.0

Default​

() => InternationalizationOptions.defaultName

formatters?​

optional formatters: I18nextFormatter[]

Defined in: projects/plugins/packages/i18next/src/lib/types.ts:118

Array of formatters to add to i18n.

Since​

2.0.0

Default​

[]

hmr?​

optional hmr: HMROptions

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

Reload languages and namespaces when updating the languages directory.

Since​

2.2.0

i18next?​

optional i18next: InitOptions | DynamicOptions<InitOptions>

Defined in: projects/plugins/packages/i18next/src/lib/types.ts:89

The options passed to i18next.init.

Since​

1.0.0