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, formato y configuración de locales.

import { GT } from 'generaltranslation';

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

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

Referencias

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';

// Configuración mínima - utiliza variables de entorno
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 de configuración regional personalizada

Se puede proporcionar una asignación personalizada. Esto permite al usuario (1) usar alias para códigos de configuración regional, (2) anular la validación estándar de BCP 47 y (3) anular la información estándar de configuración regional de 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' }
  }
});

Con las asignaciones personalizadas también puedes hacer otras cosas, como agregar nombres personalizados, emoji, etc.

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

Notas

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

Próximos pasos

• Configura tu instancia con setConfig
• Empieza a traducir con translate
• Obtén más información sobre el tipo GTConstructorParams