仪表板
Types

FileToTranslate

用于批量文件翻译操作的文件对象类型定义

概述

FileToTranslate 表示用于批量翻译操作的文件对象，可与 enqueueFiles 搭配使用。

type FileToTranslate = {
  content: string;
  fileName: string;
  fileFormat: FileFormat;
  formatMetadata?: Record<string, any>;
  dataFormat?: DataFormat;
};

属性

属性类型必填说明
contentstring是原始文件内容
fileNamestring是文件标识
fileFormatFileFormat是文件格式
formatMetadata?Record<string, any>否格式特定的元数据
dataFormat?DataFormat否文件内的数据格式

相关类型

type FileFormat = 'JSON' | 'MDX' | 'MD' | 'HTML' | 'TXT' | string;
type DataFormat = 'JSX' | 'ICU' | 'I18NEXT';

示例

JSON 文件

import { FileToTranslate } from 'generaltranslation';

const jsonFile: FileToTranslate = {
  content: JSON.stringify({
    "welcome": "欢迎",
    "save": "保存"
  }),
  fileName: 'common.json',
  fileFormat: 'JSON',
  dataFormat: 'I18NEXT'
};

MDX 文件

const mdxFile: FileToTranslate = {
  content: `# 快速开始\n\n欢迎使用我们的平台！`,
  fileName: 'docs/start.mdx',
  fileFormat: 'MDX',
  dataFormat: 'JSX'
};

相关类型

这份指南怎么样？

EntryMetadata

用于在 Entry 对象中自定义翻译行为的元数据类型定义

GTConstructorParams

GT 类构造函数参数的 TypeScript 接口定义

本页内容

概述
属性
相关类型
示例
JSON 文件
MDX 文件
相关类型
FileToTranslate