Überblick

Der GT-Konstruktor erstellt eine neue Instanz der General Translation-Klasse, die Zugriff auf sämtliche Funktionen für Übersetzung, Formatierung und Locale bietet.

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 validiert er alle angegebenen locale codes.

Referenzen

Parameter

Das Objekt GTConstructorParams unterstützt die folgenden Eigenschaften:

Rückgabewert

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

Beispiele

Grundlegende Nutzung

import { GT } from 'generaltranslation';

// Minimale Einrichtung – 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

Eine benutzerdefinierte Zuordnung kann bereitgestellt werden. Dies ermöglicht es dem Benutzer, (1) Aliasse für Locale-Codes zu verwenden, die (2) die standardmäßige BCP‑47‑Validierung überschreiben können und (3) die standardmäßigen BCP‑47‑Locale‑Informationen überschreiben.

Wenn Sie beispielsweise „cn“ als Alias für „zh“ verwenden möchten. Da die General Translation API „cn“ nicht unterstützt, müssen Sie eine benutzerdefinierte Zuordnung 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 andere Dinge tun, etwa 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 sofort und löst bei ungültigen Codes Fehler aus
• Benutzerdefinierte Zuordnungen haben Vorrang vor der standardmäßigen BCP‑47‑Validierung

Nächste Schritte

• Konfigurieren Sie Ihre Instanz mit setConfig
• Starten Sie mit dem Übersetzen über translate
• Weitere Informationen zum Typ GTConstructorParams