I18n

^{ref / i18n / I18n}

^Source

Type Parameters

C

C extends Context = Context

Constructors

I18n(config: Partial<I18nConfig<C>>);

^Source

Properties

fluent

readonly fluent: Fluent;

^Source

locales

readonly locales: Array<string>;

^Source

Methods

loadLocalesDir

loadLocalesDir(directory: string): Promise<void>;

Loads locales from the specified directory and registers them in the Fluent instance.

^Source

loadLocalesDirSync

loadLocalesDirSync(directory: string): void;

Loads locales from any existing nested file or folder within the specified directory and registers them in the Fluent instance.

^Source

loadLocale

loadLocale(locale: LocaleId, options: LoadLocaleOptions): Promise<void>;

Registers a locale in the Fluent instance based on the provided options.

^Source

loadLocaleSync

loadLocaleSync(locale: LocaleId, options: LoadLocaleOptions): void;

Synchronously registers a locale in the Fluent instance based on the provided options.

^Source

t

t<K extends string>(
  locale: LocaleId,
  key: string,
  variables?: TranslationVariables<K>,
): string;

Gets a message by its key from the specified locale. Alias of translate.

^Source

translate

translate<K extends string>(
  locale: LocaleId,
  key: string,
  variables?: TranslationVariables<K>,
): string;

Gets a message by its key from the specified locale.

^Source

middleware

middleware(): MiddlewareFn<C & I18nFlavor>;

Returns a middleware to .use on the Bot instance.

^Source