ダッシュボード

概要

generaltranslation ライブラリの概要

はじめに

generaltranslation ライブラリは、翻訳やフォーマットのためのユーティリティ関数とクラスを備えた、GT の中核となる i18n ライブラリです。 通常は gt-next や gt-react などのフレームワーク向けパッケージと併用されますが、単体のライブラリとしても利用できます。

index.ts
import { GT } from 'generaltranslation';

const gt = new GT({
  apiKey: 'your-api-key',
  projectId: 'your-project-id',
  sourceLocale: 'en',
  targetLocale: 'es',
});

// コンテンツを翻訳
const result = await gt.translate('Hello, world!', 'es');
// "¡Hola, mundo!"

// 数値、日付、通貨の書式設定
const formattedPrice = gt.formatCurrency(29.99, 'USD');
const formattedDate = gt.formatDateTime(new Date());
// "$29.99"
// "9/25/2025"

// ロケールの操作
const localeProps = gt.getLocaleProperties('fr-CA');
const isValid = gt.isValidLocale('de');
// { language: "fr", region: "CA", ... }
// true

インストール

npm install generaltranslation
yarn add generaltranslation
bun add generaltranslation
pnpm add generaltranslation

例

翻訳には大きく分けて、文字列翻訳とファイル翻訳の2種類があります。

セットアップ

翻訳を有効化するには、プロジェクトのidとAPIキーを指定する必要があります。 詳しくはconstructorメソッドを参照してください。

const gt = new GT({
  apiKey: 'your-api-key',
  projectId: 'your-project-id',
  targetLocale: 'es',
});

文字列翻訳

詳しくは translate メソッドを参照してください。

try {
  const result = await gt.translate('Hello, world!');
  console.log(result); // "¡Hola, mundo!"
} catch (error) {
  console.error('翻訳に失敗しました:', error.message);
}

ファイル翻訳

ファイルはジョブ単位で翻訳されます。 ファイルをアップロードするとジョブが開始されます。 複数のファイルをアップロードすると、その分だけ複数のジョブが開始されます。

詳しくは、uploadSourceFiles および checkFileTranslations メソッドを参照してください。

// アップロードするファイル
const files = [
  {
    source: {
      fileName: 'src/components/Button.tsx',
      fileFormat: 'TSX',
      locale: 'en',
      content: '...',
    },
  },
];

// ソースファイルをアップロード
await gt.uploadSourceFiles(files);

目次

GT クラス

翻訳と locale 機能を提供するメインクラス:

  • Constructor - 設定を指定して GT インスタンスを初期化
  • setConfig - GT インスタンスの設定を更新

翻訳メソッド

フォーマット用メソッド

ロケール関連メソッド

ユーティリティ関数

フォーマット関数

ロケール関数

型とインターフェース

TypeScript の定義:

次のステップ

フレームワーク別の利用方法は、Next.js または React のドキュメントをご覧ください。

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

クイックスタート

generaltranslation ライブラリのクイックスタートガイド

このページについて

はじめに
インストール
例
セットアップ
文字列翻訳
ファイル翻訳
目次
GT クラス
翻訳メソッド
フォーマット用メソッド
ロケール関連メソッド
ユーティリティ関数
フォーマット関数
ロケール関数
型とインターフェース
次のステップ
概要