概要

GT コンストラクタは General Translation クラスの新しいインスタンスを生成し、翻訳、フォーマット、locale に関するすべての機能へアクセスできるようにします。

import { GT } from 'generaltranslation';

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

コンストラクターは環境の GT_API_KEY と GT_PROJECT_ID という環境変数を自動的に確認するため、コンストラクターの引数でそれらを指定する必要はありません。 また、渡されたすべてのロケールコードを検証します。

リファレンス

パラメーター

GTConstructorParams オブジェクトは次のプロパティをサポートします:

返り値

すべての翻訳および locale 関連のメソッドを利用可能な、新しい GT クラス インスタンスを返します。

例

基本的な使い方

import { GT } from 'generaltranslation';

// 最小構成 - 環境変数を使用
const gt = new GT();

API 資格情報を使用する

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

カスタムロケールマッピングの使用

カスタムマッピングを指定できます。 これにより、ユーザーは (1) ロケールコードにエイリアスを使い、(2) 標準の BCP 47 検証をオーバーライドし、(3) 標準の BCP 47 のロケール情報をオーバーライドできます。

たとえば、zh のエイリアスとして cn を使いたいとします。 General Translation API は cn をサポートしていないため、カスタムマッピングを指定する必要があります。

const gt = new GT({
  projectId: 'my-project-id',
  apiKey: 'my-api-key',
  targetLocale: 'es',
  customMapping: {
    'cn': { code: 'zh' }
  }
});

カスタムマッピングでは、名称やemojiの追加など、ほかにもさまざまなことが行えます。

const gt = new GT({
  projectId: 'my-project-id',
  apiKey: 'my-api-key',
  targetLocale: 'es',
  customMapping: { 'en-US': { name: 'マンダリン', emoji: '🇫🇷' } }
});

注意事項

• すべてのパラメータは任意ですが、API の操作には apiKey と projectId が必要です
• コンストラクターはすべてのロケールコードを即時に検証し、無効なコードに対してはエラーをスローします
• カスタムマッピングは標準の BCP 47 の検証よりも優先されます

次のステップ

• setConfig でインスタンスを構成する
• translate で翻訳を開始する
• GTConstructorParams 型 について学ぶ