GT Class

Costruttore di GT

Riferimento API per il costruttore della classe GT

Panoramica

Il costruttore GT crea una nuova istanza della classe General Translation, che offre accesso a tutte le funzionalità di traduzione, formattazione e gestione delle impostazioni locali (locale).

import { GT } from 'generaltranslation';

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

Il costruttore verificherà automaticamente nell’ambiente la presenza delle variabili GT_API_KEY e GT_PROJECT_ID, quindi puoi ometterle dai parametri del costruttore. Inoltre, convaliderà tutti i codici locale forniti.


Riferimenti

Parametri

Prop

Type

L'oggetto GTConstructorParams supporta le seguenti proprietà:

ProprietàTipoOpzionaleDescrizione
apiKeystringChiave API di produzione per il servizio di traduzione
devApiKeystringChiave API di sviluppo (ha la precedenza in ambienti di sviluppo)
projectIdstringIdentificatore univoco del progetto
sourceLocalestringLocale di origine predefinito per le traduzioni
targetLocalestringLocale di destinazione predefinito per le traduzioni
localesstring[]Elenco di codici locale supportati
baseUrlstringURL base dell'API personalizzato (per distribuzioni enterprise)
customMappingCustomMappingMapping e definizioni personalizzati dei codici locale

Restituisce

Una nuova istanza della classe GT con tutti i metodi di traduzione e localizzazione disponibili.


Esempi

Uso di base

import { GT } from 'generaltranslation';

// Configurazione minima - usa variabili d'ambiente
const gt = new GT();

Con credenziali API

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

Con mappatura locale personalizzata

È possibile definire una mappatura personalizzata. Questo consente di (1) usare alias per i codici locale, (2) ignorare la convalida standard BCP 47 e (3) sostituire le informazioni standard del locale BCP 47.

Ad esempio, se vuoi usare cn come alias di zh. Poiché l’API di General Translation non supporta cn, devi specificare una mappatura personalizzata.

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

Con i mapping personalizzati puoi fare anche altro, ad esempio aggiungere nomi personalizzati, emoji, ecc.

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

Note

  • Tutti i parametri sono facoltativi, ma le operazioni API richiedono apiKey e projectId
  • Il costruttore convalida immediatamente tutti i codici locale, generando errori per quelli non validi
  • Le mappature personalizzate hanno priorità rispetto alla convalida standard BCP 47

Prossimi passaggi

Come valuti questa guida?

Costruttore di GT