概要

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: 'Mandarin', emoji: '🇫🇷' } }
});

注意事項

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

次のステップ

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