ダッシュボード
Types

翻訳対象ファイル

バッチ翻訳処理で使用されるファイルオブジェクトの型定義

概要

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ファイル
関連する型
翻訳対象ファイル