Types

GTConstructorParams

Interface TypeScript pour les paramètres du constructeur de la classe GT

Présentation

GTConstructorParams définit les options de configuration pour l’initialisation de la classe GT.

interface GTConstructorParams {
  apiKey?: string;
  devApiKey?: string;
  sourceLocale?: string;
  targetLocale?: string;
  locales?: string[];
  projectId?: string;
  baseUrl?: string;
  customMapping?: CustomMapping;
}

Toutes les propriétés sont facultatives. Le constructeur lit GT_API_KEY, GT_DEV_API_KEY et GT_PROJECT_ID depuis les variables d’environnement si elles ne sont pas fournies.

Propriétés

PropriétéTypeDescription
apiKey?stringClé d’API de production
devApiKey?stringClé d’API de développement
sourceLocale?stringLocale source par défaut
targetLocale?stringlocaleCible par défaut
locales?string[]Codes de locale pris en charge
projectId?stringIdentifiant du projet
baseUrl?stringPoint de terminaison d’API personnalisé
customMapping?CustomMappingMappages de locales personnalisés

Exemples

Configuration de base

const gt = new GT({
  apiKey: 'your-api-key',
  sourceLocale: 'en',
  targetLocale: 'es',
  locales: ['en', 'es', 'fr']
});

Avec des variables d’environnement

const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'es'
});
// Utilise GT_API_KEY et GT_PROJECT_ID depuis l'environnement

Types associés

Comment trouvez-vous ce guide ?