Обзор

Конструктор GT создаёт новый экземпляр класса General Translation, предоставляющий доступ ко всем функциям перевода, форматирования и работы с локалями.

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 поддерживает следующие свойства:

Возвращает

Новый экземпляр класса GT со всеми доступными методами перевода и работы с локалями.

Примеры

Базовое использование

import { GT } from 'generaltranslation';

// Minimal setup - uses environment variables
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.

Например, предположим, что вы хотите использовать cn как алиас для zh. Поскольку API General Translation не поддерживает cn, необходимо указать пользовательское сопоставление.

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

С пользовательскими сопоставлениями можно делать и другие вещи — например, добавлять собственные названия, эмодзи и т. п.

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