Présentation

Le constructeur GT crée une nouvelle instance de la classe General Translation, offrant l’accès à l’ensemble des fonctionnalités de traduction, de formatage et de gestion des locales.

import { GT } from 'generaltranslation';

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

Le constructeur détecte automatiquement les variables d’environnement GT_API_KEY et GT_PROJECT_ID, vous pouvez donc les omettre des paramètres du constructeur. Il valide également tous les codes de locale fournis.

Références

Paramètres

L’objet GTConstructorParams prend en charge les propriétés suivantes :

Renvoie

Une nouvelle instance de la classe GT avec toutes les méthodes de traduction et de gestion des locales disponibles.

Exemples

Utilisation de base

import { GT } from 'generaltranslation';

// Configuration minimale - utilise les variables d'environnement
const gt = new GT();

Avec des identifiants d’API

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

Avec un mapping de locales personnalisé

Vous pouvez fournir un mapping personnalisé. Cela permet à l’utilisateur (1) d’utiliser des alias pour des codes de locale, (2) de passer outre la validation BCP 47 standard, et (3) de remplacer les informations de locale BCP 47 standard.

Par exemple, si vous souhaitez utiliser cn comme alias de zh. Comme la General Translation API ne prend pas en charge cn, vous devez spécifier un mapping personnalisé.

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

Vous pouvez aussi utiliser des mappages personnalisés pour, par exemple, ajouter des noms personnalisés, des emoji, etc.

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

Remarques

• Tous les paramètres sont facultatifs, mais les opérations d’API nécessitent apiKey et projectId
• Le constructeur valide immédiatement tous les codes de locale et génère une Error pour tout code invalide
• Les mappages personnalisés ont priorité sur la validation BCP 47 standard

Prochaines étapes

• Configurez votre instance avec setConfig
• Commencez la traduction avec translate
• Découvrez le type GTConstructorParams