ブログダッシュボード
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 ファイル
関連する型