admin-vben/packages/locales/src/typing.ts

26 lines
574 B
TypeScript

export type SupportedLanguagesType = 'en-US' | 'zh-CN';
export type ImportLocaleFn = () => Promise<{ default: Record<string, string> }>;
export type LoadMessageFn = (
lang: SupportedLanguagesType,
) => Promise<Record<string, string> | undefined>;
export interface LocaleSetupOptions {
/**
* Default language
* @default zh-CN
*/
defaultLocale?: SupportedLanguagesType;
/**
* Load message function
* @param lang
* @returns
*/
loadMessages?: LoadMessageFn;
/**
* Whether to warn when the key is not found
*/
missingWarn?: boolean;
}