# generaltranslation: General Translation Core SDK: resumen
URL: https://generaltranslation.com/es/docs/core.mdx
---
title: resumen
description: Descripción general de la biblioteca generaltranslation
---

## Introducción

La biblioteca `generaltranslation` es la biblioteca principal de i18n de GT y alberga funciones de utilidad y clases para la traducción y el formato.
Suele usarse con paquetes de frameworks como `gt-next` y `gt-react`, pero también puede usarse como biblioteca independiente.

import Video from '@/components/Video';

<Video src="https://assets.gtx.dev/core-demo.mp4" />

```typescript title="index.ts"
import { GT } from 'generaltranslation';

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

// Traducir contenido
const result = await gt.translate('Hello, world!', 'es');
// "¡Hola, mundo!"

// Dar formato a números, fechas y monedas
const formattedPrice = gt.formatNum(29.99, { style: 'currency', currency: 'USD' });
const formattedDate = gt.formatDateTime(new Date());
// "$29.99"
// "9/25/2025"

// Trabajar con configuraciones regionales
const localeProps = gt.getLocaleProperties('fr-CA');
const isValid = gt.isValidLocale('de');
// { language: "fr", region: "CA", ... }
// true
```

***


## Instalación

<Tabs items={['npm', 'yarn', 'bun', 'pnpm']}>
  <Tab value="npm">
    ```bash
    npm install generaltranslation
    ```
  </Tab>

  <Tab value="yarn">
    ```bash
    yarn add generaltranslation
    ```
  </Tab>

  <Tab value="bun">
    ```bash
    bun add generaltranslation
    ```
  </Tab>

  <Tab value="pnpm">
    ```bash
    pnpm add generaltranslation
    ```
  </Tab>
</Tabs>

***

## Ejemplos

Hay dos tipos principales de traducción: traducción de cadenas y traducción de archivo.

### Configuración

Para habilitar la traducción, debes proporcionar un ID del proyecto y una clave API.
Consulta el método [`constructor`](/docs/core/class/constructor) para obtener más información.

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


### Traducción de cadenas

Consulta el método [`translate`](/docs/core/class/methods/translation/translate) para obtener más información.

```typescript
try {
  const result = await gt.translate('Hello, world!');
  console.log(result); // "¡Hola, mundo!"
} catch (error) {
  console.error('La traducción falló:', error.message);
}
```


### Traducción de archivo

Los archivos se traducen mediante trabajos.
Para lanzar un trabajo, carga un archivo.
Si cargas muchos archivos, se lanzarán muchos trabajos.

Consulta los métodos [`uploadSourceFiles`](/docs/core/class/methods/translation/upload-source-files)
y [`queryFileData`](/docs/core/class/methods/translation/query-file-data) para obtener más información.

```typescript
// Archivos para cargar
const files = [
  {
    source: {
      fileName: 'src/components/Button.tsx',
      fileFormat: 'TSX',
      locale: 'en',
      content: '...',
    },
  },
];

// Cargar archivos de origen
await gt.uploadSourceFiles(files);
```

***


## Índice

### Clase GT

Clase principal para la traducción y las funciones de configuración regional:

* **[Constructor](/docs/core/class/constructor)** - Inicializa la instancia de GT con la configuración
* **[setConfig](/docs/core/class/set-config)** - Actualiza la configuración de la instancia de GT

#### Métodos de traducción

* **[translate](/docs/core/class/methods/translation/translate)** - Funcionalidad principal de traducción
* **[translateMany](/docs/core/class/methods/translation/translate-many)** - Traducción por lotes
* **[setupProject](/docs/core/class/methods/translation/setup-project)** - Inicialización del proyecto
* **[checkJobStatus](/docs/core/class/methods/translation/check-job-status)** - Comprobar el progreso del trabajo
* **[getProjectData](/docs/core/class/methods/translation/get-project-data)** - Obtener información del proyecto
* **[uploadSourceFiles](/docs/core/class/methods/translation/upload-source-files)** - Cargar archivos para su traducción
* **[uploadTranslations](/docs/core/class/methods/translation/upload-translations)** - Cargar traducciones existentes
* **[enqueueFiles](/docs/core/class/methods/translation/enqueue-files)** - Poner en cola archivos para su procesamiento
* **[queryFileData](/docs/core/class/methods/translation/query-file-data)** - Comprobar el estado de la traducción
* **[downloadFile](/docs/core/class/methods/translation/download-file)** - Descargar un único archivo
* **[downloadFileBatch](/docs/core/class/methods/translation/download-file-batch)** - Descargar varios archivos
* **[querySourceFile](/docs/core/class/methods/translation/query-source-file)** - Consultar información del archivo de origen

#### Métodos de formato

* **[formatMessage](/docs/core/class/methods/formatting/format-message)** - Formato internacionalizado de texto
* **[formatNum](/docs/core/class/methods/formatting/format-num)** - Formato de número
* **[formatDateTime](/docs/core/class/methods/formatting/format-date-time)** - Formato de fecha y hora

#### Métodos de configuración regional

* **[getLocaleName](/docs/core/class/methods/locales/get-locale-name)** - Obtener el nombre de visualización de la configuración regional
* **[getLocaleProperties](/docs/core/class/methods/locales/get-locale-properties)** - Obtener información completa de la configuración regional
* **[getLocaleDirection](/docs/core/class/methods/locales/get-locale-direction)** - Obtener la dirección del texto de la configuración regional
* **[getLocaleEmoji](/docs/core/class/methods/locales/get-locale-emoji)** - Obtener el emoji de opción de la configuración regional
* **[getRegionProperties](/docs/core/class/methods/locales/get-region-properties)** - Obtener información y propiedades de la región
* **[isValidLocale](/docs/core/class/methods/locales/is-valid-locale)** - Validar el código de configuración regional
* **[resolveAliasLocale](/docs/core/class/methods/locales/resolve-alias-locale)** - Convertir configuraciones regionales canónicas en alias
* **[resolveCanonicalLocale](/docs/core/class/methods/locales/resolve-canonical-locale)** - Convertir alias de configuración regional a su forma canónica
* **[standardizeLocale](/docs/core/class/methods/locales/standardize-locale)** - Estandarizar el formato del código de configuración regional
* **[isSameDialect](/docs/core/class/methods/locales/is-same-dialect)** - Comprobar si las configuraciones regionales representan el mismo dialecto
* **[isSameLanguage](/docs/core/class/methods/locales/is-same-language)** - Comprobar si las configuraciones regionales representan el mismo idioma
* **[isSupersetLocale](/docs/core/class/methods/locales/is-superset-locale)** - Comprobar las relaciones jerárquicas de la configuración regional
* **[determineLocale](/docs/core/class/methods/locales/determine-locale)** - Encontrar la configuración regional que mejor coincida según las preferencias
* **[requiresTranslation](/docs/core/class/methods/locales/requires-translation)** - Determinar si se necesita traducción

### Funciones de utilidad

#### Funciones de formato

* **[formatMessage](/docs/core/functions/formatting/format-message)** - Formato de texto independiente
* **[formatNum](/docs/core/functions/formatting/format-num)** - Formato de números independiente
* **[formatDateTime](/docs/core/functions/formatting/format-date-time)** - Formato de fecha y hora independiente

#### Funciones de configuración regional

* **[getLocaleName](/docs/core/functions/locales/get-locale-name)** - Utilidad independiente para el nombre de la configuración regional
* **[getLocaleProperties](/docs/core/functions/locales/get-locale-properties)** - Propiedades independientes de la configuración regional
* **[getLocaleDirection](/docs/core/functions/locales/get-locale-direction)** - Utilidad independiente para la dirección del texto
* **[getLocaleEmoji](/docs/core/functions/locales/get-locale-emoji)** - Utilidad independiente para emoji
* **[getRegionProperties](/docs/core/functions/locales/get-region-properties)** - Utilidad independiente para las propiedades de la región
* **[isValidLocale](/docs/core/functions/locales/is-valid-locale)** - Validación independiente de la configuración regional
* **[resolveAliasLocale](/docs/core/functions/locales/resolve-alias-locale)** - Resolución independiente de alias de configuración regional
* **[standardizeLocale](/docs/core/functions/locales/standardize-locale)** - Estandarización independiente de la configuración regional
* **[isSameDialect](/docs/core/functions/locales/is-same-dialect)** - Comparación independiente de dialectos
* **[isSameLanguage](/docs/core/functions/locales/is-same-language)** - Comparación independiente de idiomas
* **[isSupersetLocale](/docs/core/functions/locales/is-superset-locale)** - Comprobación independiente de la jerarquía de configuración regional
* **[determineLocale](/docs/core/functions/locales/determine-locale)** - Negociación independiente de configuración regional
* **[requiresTranslation](/docs/core/functions/locales/requires-translation)** - Comprobación independiente de si se requiere traducción

### Tipos e interfaces

Definiciones de TypeScript:

* **[GTConstructorParams](/docs/core/types/gt-constructor-params)** - Opciones de configuración
* **[LocaleProperties](/docs/core/types/locale-properties)** - Información completa de la configuración regional
* **[TranslationResult](/docs/core/types/translation-result)** - Tipos de respuesta de traducción
* **[TranslateManyResult](/docs/core/types/translate-many-result)** - Respuesta de traducción en lote
* **[FileToTranslate](/docs/core/types/file-to-translate)** - Configuración de traducción de archivo
* **[EnqueueFilesOptions](/docs/core/types/enqueue-files-options)** - Opciones para poner archivos en cola
* **[Entry](/docs/core/types/Entry)** - Estructura de la entrada de traducción
* **[EntryMetadata](/docs/core/types/entry-metadata)** - Metadatos de la entrada
* **[Content](/docs/core/types/Content)** - Definiciones del tipo de contenido
* **[Variable](/docs/core/types/Variable)** - Estructura de variable
* **[VariableType](/docs/core/types/variable-type)** - Definiciones del tipo de variable
* **[JsxElement](/docs/core/types/jsx-element)** - Tipo de elemento JSX
* **[JsxChild](/docs/core/types/jsx-child)** - Tipo de elemento hijo de JSX
* **[JsxChildren](/docs/core/types/jsx-children)** - Tipo de elementos hijo de JSX
* **[DataFormat](/docs/core/types/data-format)** - Especificaciones del formato de datos
* **[CustomMapping](/docs/core/types/custom-mapping)** - Configuración de asignación personalizada

***

## Siguientes pasos

* **[Empezar con la clase GT](/docs/core/class/constructor)**
* **[Explorar los métodos de traducción](/docs/core/class/methods/translation/translate)**
* **[Conocer las utilidades de configuración regional](/docs/core/class/methods/locales/get-locale-name)**
* **[Consultar las opciones de formato](/docs/core/class/methods/formatting/format-message)**
* **[Explorar las funciones independientes](/docs/core/functions/formatting/format-message)**

Para el uso específico de cada framework, consulta la documentación de [Next.js](/docs/next) o [React](/docs/react).