2024-07-28 14:29:05 +08:00
|
|
|
export type SupportedLanguagesType = 'en-US' | 'zh-CN';
|
2024-05-19 21:20:42 +08:00
|
|
|
|
2024-07-28 14:29:05 +08:00
|
|
|
export type ImportLocaleFn = () => Promise<{ default: Record<string, string> }>;
|
2024-05-19 21:20:42 +08:00
|
|
|
|
2024-07-28 14:29:05 +08:00
|
|
|
export type LoadMessageFn = (
|
2024-07-07 00:17:44 +08:00
|
|
|
lang: SupportedLanguagesType,
|
|
|
|
) => Promise<Record<string, string>>;
|
|
|
|
|
2024-07-28 14:29:05 +08:00
|
|
|
export interface LocaleSetupOptions {
|
2024-05-19 21:20:42 +08:00
|
|
|
/**
|
|
|
|
* Default language
|
|
|
|
* @default zh-CN
|
|
|
|
*/
|
2024-06-02 20:47:50 +08:00
|
|
|
defaultLocale?: SupportedLanguagesType;
|
2024-06-30 15:42:30 +08:00
|
|
|
/**
|
2024-07-07 00:17:44 +08:00
|
|
|
* Load message function
|
2024-06-30 15:42:30 +08:00
|
|
|
* @param lang
|
|
|
|
* @returns
|
|
|
|
*/
|
2024-07-07 00:17:44 +08:00
|
|
|
loadMessages?: LoadMessageFn;
|
2024-07-07 02:00:51 +08:00
|
|
|
/**
|
|
|
|
* Whether to warn when the key is not found
|
|
|
|
*/
|
|
|
|
missingWarn?: boolean;
|
2024-05-19 21:20:42 +08:00
|
|
|
}
|