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?stringsourceLocale のオーバーライド
actionType?ActionType翻訳モデルの優先度設定
timeout?numberリクエストのタイムアウト(ms)
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}件}}',
  targetLocale: 'es',
  metadata: {
    dataFormat: 'ICU',
    context: '件数'
  }
};

関連する型

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

このガイドはいかがですか?