Vue d’ensemble

Le constructeur GT crée une nouvelle instance de la classe General Translation, qui donne accès à toutes les 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 recherchera automatiquement les variables d’environnement GT_API_KEY et GT_PROJECT_ID dans l’environnement, vous pouvez donc les omettre des paramètres du constructeur. Il validera é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 locale disponibles.

Exemples

Utilisation de base

import { GT } from 'generaltranslation';

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

Avec des identifiants API

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

Avec un mappage de locales personnalisé

Vous pouvez définir un mappage personnalisé. Cela permet (1) d’utiliser des alias pour les codes de locale, (2) d’outrepasser la validation BCP 47 standard et (3) de remplacer les informations de locale standard BCP 47.

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

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

Vous pouvez faire d’autres choses avec les mappages personnalisés, comme 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: '🇫🇷' } }
});

Notes

• Tous les paramètres sont facultatifs, mais les opérations de l’API nécessitent apiKey et projectId
• Le constructeur valide immédiatement tous les code de locale, et lève des Error pour les codes invalides
• Les correspondances personnalisées priment sur la validation standard BCP 47

Prochaines étapes

• Configurez votre instance avec setConfig
• Commencez à traduire avec translate
• En savoir plus sur le type GTConstructorParams