GT Class

setConfig

Référence de l’API de la méthode GT setConfig

Présentation

La méthode setConfig met à jour la configuration d’une instance GT existante. Elle vous permet de modifier les identifiants de l’API, les locales et d’autres paramètres après la création de l’instance.

const gt = new GT();

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

La méthode setConfig valide tous les codes de locale fournis et les fusionne avec toute configuration existante passée au constructeur.


Références

Paramètres

Prop

Type

L’objet GTConstructorParams prend en charge les mêmes propriétés que le constructeur :

PropriétéTypeOptionnelDescription
apiKeystringClé d’API de production pour le service de traduction
devApiKeystringClé d’API de développement
projectIdstringIdentifiant unique du projet
sourceLocalestringLocale source par défaut pour les traductions
targetLocalestringLocale cible par défaut pour les traductions
localesstring[]Tableau des codes de locale pris en charge
baseUrlstringURL de base personnalisée de l’API
customMappingCustomMappingMappages personnalisés des codes de locale

Renvoie

void - La méthode met à jour la configuration de l’instance en place.


Exemple

Dans cet exemple, nous changeons la locale cible, de l’espagnol au français.

const gt = new GT({
  sourceLocale: 'en',
  localeCible: 'es'
});

// Basculer vers le français
gt.setConfig({
  localeCible: 'fr'
});

Notes

  • Les modifications de configuration prennent effet immédiatement pour les appels de méthode suivants
  • Les variables d’environnement ne sont pas relues lors de l’appel à setConfig
  • Les correspondances personnalisées remplacent entièrement les correspondances existantes (aucune fusion)
  • En cas d’échec de validation, la configuration de l’instance reste inchangée
  • La méthode est synchrone et renvoie void

Prochaines étapes

Que pensez-vous de ce guide ?

setConfig