ダッシュボード
Types

EntryMetadata

Entry オブジェクトの翻訳動作をカスタマイズするメタデータの型定義

概要

EntryMetadata は、バッチ翻訳処理で使用する Entry オブジェクトに対して、任意の構成を提供します。

type EntryMetadata = {
  context?: string;
  id?: string;
  hash?: string;
  dataFormat?: DataFormat;
  sourceLocale?: string;
  actionType?: ActionType;
  timeout?: number;
  regionCode?: string;
  scriptCode?: string;
};

プロパティ

プロパティ型説明
context?string翻訳者向けのコンテキスト
id?string一意の識別子
hash?stringキャッシュ用コンテンツのハッシュ
dataFormat?DataFormatフォーマット仕様
sourceLocale?stringソース locale の上書き
actionType?ActionType翻訳モデルの優先設定
timeout?numberリクエストのタイムアウト（ミリ秒）
regionCode?stringISO 地域コード
scriptCode?stringISO スクリプトコード

関連型

type DataFormat = 'JSX' | 'ICU' | 'I18NEXT';
type ActionType = 'standard' | 'fast' | string;

例

基本的な使い方

import { Entry, EntryMetadata } from 'generaltranslation';

const metadata: EntryMetadata = {
  context: 'ボタンテキスト',
  actionType: 'fast'
};

const entry: Entry = {
  source: '保存',
  targetLocale: 'es',
  metadata
};

ICU フォーマット対応

const icuEntry: Entry = {
  source: '{count, plural, other {{count} items}}',
  targetLocale: 'es',
  metadata: {
    dataFormat: 'ICU',
    context: 'アイテム数'
  }
};

関連する型

  • Entry - このメタデータを利用する親タイプ
  • ActionType - 翻訳モデルのoptions

このガイドはどうでしたか？

EnqueueFilesOptions

バッチファイル翻訳処理の設定options

翻訳対象ファイル

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

このページについて

概要
プロパティ
関連型
例
基本的な使い方
ICU フォーマット対応
関連する型
EntryMetadata