Types
FileToTranslate
Определение типа для объектов файла, используемых в пакетных операциях перевода файлов
Обзор
FileToTranslate — это объект файла для пакетных операций перевода с использованием enqueueFiles.
type FileToTranslate = {
content: string;
fileName: string;
fileFormat: FileFormat;
formatMetadata?: Record<string, any>;
dataFormat?: DataFormat;
};Свойства
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
content | string | Да | Необработанное содержимое файла |
fileName | string | Да | Идентификатор файла |
fileFormat | FileFormat | Да | Формат файла |
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'
};Связанные типы
EnqueueFilesOptions— параметры пакетной обработки
Насколько полезно это руководство?