# vue: GTFunction
URL: https://generaltranslation.com/es/docs/vue/reference/types/gt-function.mdx
---
title: GTFunction
description: Describe el callback síncrono utilizado para búsqueda en catálogos de cadenas simples de Vue. Referencia de la API de GTFunction.

---

El callback que devuelve [`useGT()`](/docs/vue/reference/composables/use-gt) y la exportación [`t()`](/docs/vue/reference/functions/t) de nivel de módulo comparten esta firma. La gestión de su estado y su disponibilidad difieren, pero el resultado de la búsqueda es el mismo.

## Resumen [#overview]

```ts
type GTFunction = (
  message: string,
  options?: GTStringOptions
) => string;
```

| Parámetro             | Descripción                                          | Tipo                                                             | Opcional | Predeterminado |
| --------------------- | ---------------------------------------------------- | ---------------------------------------------------------------- | -------- | -------------- |
| [`message`](#message) | Cadena de origen que se va a traducir.               | `string`                                                         | No       | —              |
| [`options`](#options) | Contexto opcional utilizado en el hash del catálogo. | [`GTStringOptions`](/docs/vue/reference/types/gt-string-options) | Sí       | `{}`           |

## Parámetros [#parameters]

### `message`

**Tipo** `string` · **Obligatorio**

El texto de origen literal que se utiliza para calcular un hash `STRING` simple. Las llaves forman parte de ese texto; no son marcadores de posición para interpolación.

### `options`

**Tipo** [`GTStringOptions`](/docs/vue/reference/types/gt-string-options) · **Opcional** · **Predeterminado** `{}`

Solo se admite `$context`. Permite distinguir cadenas de origen idénticas.

## Valor de retorno [#returns]

**Tipo** `string`

Devuelve el valor de cadena del catálogo activo para el hash calculado. Si no existe una entrada o el valor del catálogo no es una cadena, devuelve `message` sin cambios.

La búsqueda es síncrona y no realiza operaciones de red, procesamiento de ICU ni interpolación.

## Implementaciones [#implementations]

| API                                                 | Fuente del estado                                                                                                  | Actualizaciones de configuración regional                                                                                                                                                |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`useGT()`](/docs/vue/reference/composables/use-gt) | El [`GTPlugin`](/docs/vue/reference/types/gt-plugin) instalado en la aplicación Vue actual.                        | Llame al callback desde una plantilla, un valor calculado o un efecto reactivo para volver a ejecutarlo cuando un plugin reactivo cambie la configuración regional o cargue un catálogo. |
| [`t()`](/docs/vue/reference/functions/t)            | El runtime global del navegador creado por [`initializeGTSPA()`](/docs/vue/reference/functions/initialize-gt-spa). | Los resultados de nivel de módulo solo se actualizan después de que el establecedor de configuración regional de la SPA recargue la página y los módulos vuelvan a evaluarse.            |

Llamar a [`useGT()`](/docs/vue/reference/composables/use-gt) sin un plugin instalado genera una excepción cuando el composable intenta acceder al estado. Llamar a [`t()`](/docs/vue/reference/functions/t) en el servidor o antes de que finalice la inicialización de la SPA también genera una excepción.

## Ejemplo [#example]

```ts
import type { GTFunction } from 'gt-vue';

function translateNavigation(gt: GTFunction) {
  return {
    home: gt('Home'),
    settings: gt('Settings'),
  };
}
```