Übersicht

Der GT-Konstruktor erstellt eine neue Instanz der General Translation-Klasse und stellt damit Zugriff auf alle Funktionen für Übersetzung, Formatierung und Locale bereit.

import { GT } from 'generaltranslation';

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

Der Konstruktor prüft die Umgebung automatisch auf die Umgebungsvariablen GT_API_KEY und GT_PROJECT_ID, sodass Sie diese in den Konstruktorparametern weglassen können. Außerdem überprüft er alle angegebenen locale codes auf Gültigkeit.

Referenz

Parameter

Das Objekt GTConstructorParams unterstützt die folgenden Eigenschaften:

Rückgabe

Eine neue GT-Klasseninstanz mit allen verfügbaren Übersetzungs- und locale-Methoden.

Beispiele

Grundlegende Verwendung

import { GT } from 'generaltranslation';

// Minimale Konfiguration - verwendet Umgebungsvariablen
const gt = new GT();

Mit API-Anmeldedaten

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

Mit benutzerdefiniertem Locale-Mapping

Ein benutzerdefiniertes Mapping kann bereitgestellt werden. Dadurch kann der Nutzer (1) Aliasse für locale codes verwenden, (2) die standardmäßige BCP‑47‑Validierung außer Kraft setzen und (3) die standardmäßigen BCP‑47‑Locale‑Informationen überschreiben.

Wenn Sie zum Beispiel cn als Alias für zh verwenden möchten. Da die General Translation API cn nicht unterstützt, müssen Sie ein benutzerdefiniertes Mapping angeben.

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

Mit benutzerdefinierten Zuordnungen können Sie auch anderes erledigen, zum Beispiel eigene Namen, Emojis usw. hinzufügen.

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

Hinweise

• Alle Parameter sind optional, aber API‑Operationen erfordern apiKey und projectId
• Der Konstruktor validiert alle Locale-Codes unmittelbar und wirft bei ungültigen Codes eine Error‑Exception
• Benutzerdefinierte Zuordnungen haben Vorrang vor der Standardvalidierung nach BCP 47

Nächste Schritte

• Konfigurieren Sie Ihre Instanz mit setConfig
• Beginnen Sie mit dem Übersetzen mit translate
• Erfahren Sie mehr über den Typ GTConstructorParams