Descripción general

El constructor GT crea una nueva instancia de la clase General Translation, que proporciona acceso a todas las funciones de traducción, formateo y gestión de locales.

import { GT } from 'generaltranslation';

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

El constructor comprobará automáticamente el entorno en busca de las variables de entorno GT_API_KEY y GT_PROJECT_ID, por lo que puedes omitirlas de los parámetros del constructor. Además, validará todos los códigos de configuración regional proporcionados.

Referencia

Parámetros

El objeto GTConstructorParams admite las siguientes propiedades:

Devuelve

Una nueva instancia de la clase GT con todos los métodos de traducción y de locale disponibles.

Ejemplos

Uso básico

import { GT } from 'generaltranslation';

// Minimal setup - uses environment variables
const gt = new GT();

Con credenciales de la API

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

Con asignación personalizada de configuración regional

Se puede proporcionar una asignación personalizada. Esto permite al usuario (1) usar alias para códigos de configuración regional, (2) omitir la validación estándar BCP 47 y (3) reemplazar la información estándar de configuración regional BCP 47.

Por ejemplo, supongamos que quieres usar cn como alias de zh. Dado que la General Translation API no admite cn, debes especificar una asignación personalizada.

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

Puedes hacer otras cosas con asignaciones personalizadas, como añadir nombres personalizados, emoji, etc.

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

Notas

• Todos los parámetros son opcionales, pero las operaciones de la API requerirán apiKey y projectId
• El constructor valida inmediatamente todos los códigos de configuración regional y arroja errores para los códigos inválidos
• Las asignaciones personalizadas tienen prioridad sobre la validación estándar de BCP 47

Próximos pasos

• Configura tu instancia con setConfig
• Comienza a traducir con translate
• Obtén información sobre el tipo GTConstructorParams