i18n-auto-react/dist/index.d.ts

基于百度翻译API服务的自动翻译插件

type ImportInfo = {
    /**
     * 引入源
     */
    source: string;
    /**
     * 引入函数名称
     */
    imported: string;
    /**
     * 函数别名，默认为 _${imported}
     */
    local: string;
};
type LngType = 'zh' | 'en' | 'yue' | 'wyw' | 'jp' | 'kor' | 'fra' | 'spa' | 'th' | 'ara' | 'ru' | 'pt' | 'de' | 'it' | 'el' | 'nl' | 'pl' | 'bul' | 'est' | 'dan' | 'fin' | 'cs' | 'rom' | 'slo' | 'swe' | 'hu' | 'cht' | 'vie';
interface I18nConfigs {
    /**
     * 入口文件夹路径
     */
    entry: string | string[];
    /**
     * 出口路径
     */
    output: {
        /**
         * 出口文件夹名称
         */
        dir: string;
        /**
         * 文件扩展名
         */
        ext: 'js' | 'ts';
    };
    /**
     * 查找文件规则
     */
    test: RegExp | string;
    /**
     * 包含的文件或文件夹，优先级高于exclude
     */
    include: string | Array<string>;
    /**
     * 排除的文件夹或文件
     */
    exclude: string | Array<string>;
    /**
     * 要翻译的语种, 支持语种：https://api.fanyi.baidu.com/doc/21
     */
    languages: LngType[];
    /**
     * 导入翻译工具库
     */
    importInfo: ImportInfo;
    /**
     * 导出语言包模板
     * $data为语言包对象
     * $name为语言名称
     * @default 'export default $data'
     */
    template: string;
    /**
     * 是否显示警告，打包时检查中文是否存在语言包中
     */
    warning: boolean;
    /**
     * 百度翻译开放平台服务
     */
    server: {
        /**
         * appId
         */
        appId: string;
        /**
         * 密钥
         */
        key: string;
        /**
         * qps
         */
        qps: number;
    };
}

type TranslateFn<T = any> = (str: T, data?: object) => T;
declare let localStorageKey: string;
/**
 * 扩展语言包数据
 * @param {LngType} name 语种名称
 * @param {object} config 语言包数据
 * @param {boolean} cover 是否覆盖
 */
declare function extendLocale(name: LngType, config: Record<string, string>, cover?: boolean): void;
/**
 * 删除语言包数据
 * @param name 语种名称
 * @param {string[] | string} key 键值
 */
declare function removeLocaleData(name: LngType, key: Array<string> | string): void;
/**
 * 翻译函数
 */
declare const i18n: TranslateFn<any>;
/**
 * 切换语言
 * @param {LngType} locale 语言类型
 */
declare function changeLanguage(locale: LngType): void;
/**
 * 返回当前语言
 * @returns {LngType}
 */
declare function currentLanguage(): LngType;

export { changeLanguage, currentLanguage, extendLocale, i18n, localStorageKey, removeLocaleData };
export type { I18nConfigs, LngType };