You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 lines
1.2 KiB
TypeScript
38 lines
1.2 KiB
TypeScript
// this file is a weird one as it is used by both sides of electron at the same time
|
|
|
|
import { isEmpty } from 'lodash';
|
|
import { LocalizerDictionary, SetupI18nReturnType } from '../../types/Localizer';
|
|
import { getMessage } from './functions/getMessage';
|
|
import { i18nLog, Locale, setInitialLocale } from './shared';
|
|
|
|
/**
|
|
* Sets up the i18n function with the provided locale and messages.
|
|
*
|
|
* @param params - An object containing optional parameters.
|
|
* @param params.locale - The locale to use for translations
|
|
* @param params.translationDictionary - A dictionary of localized messages. Defaults to {@link en}.
|
|
*
|
|
* @returns A function that retrieves a localized message string, substituting variables where necessary.
|
|
*/
|
|
export const setupI18n = ({
|
|
locale,
|
|
translationDictionary,
|
|
}: {
|
|
locale: Locale;
|
|
translationDictionary: LocalizerDictionary;
|
|
}): SetupI18nReturnType => {
|
|
if (!locale) {
|
|
throw new Error(`locale not provided in i18n setup`);
|
|
}
|
|
|
|
if (!translationDictionary || isEmpty(translationDictionary)) {
|
|
throw new Error('translationDictionary was not provided');
|
|
}
|
|
|
|
setInitialLocale(locale, translationDictionary);
|
|
|
|
i18nLog(`Setup Complete with locale: ${locale}`);
|
|
|
|
return getMessage;
|
|
};
|