# vue: GTFunction
URL: https://generaltranslation.com/fr/docs/vue/reference/types/gt-function.mdx
---

title: GTFunction
description: Décrit le callback synchrone utilisé pour rechercher des chaînes simples dans le catalogue Vue. Référence de l’API de GTFunction.

---

Le callback renvoyé par [`useGT()`](/docs/vue/reference/composables/use-gt) et l’export [`t()`](/docs/vue/reference/functions/t) défini au niveau du module partagent cette signature. La gestion de leur état et leur disponibilité diffèrent, mais le résultat de la recherche est le même.

## Vue d’ensemble [#overview]

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

| Paramètre             | Description                                               | Type                                                             | Facultatif | Par défaut |
| --------------------- | --------------------------------------------------------- | ---------------------------------------------------------------- | ---------- | ---------- |
| [`message`](#message) | Chaîne source à traduire.                                 | `string`                                                         | Non        | —          |
| [`options`](#options) | Contexte facultatif utilisé dans le hachage du catalogue. | [`GTStringOptions`](/docs/vue/reference/types/gt-string-options) | Oui        | `{}`       |

## Paramètres [#parameters]

### `message`

**Type** `string` · **Obligatoire**

Le texte source littéral utilisé pour calculer un hachage `STRING` brut. Les accolades font partie de ce texte ; elles ne sont pas des espaces réservés pour l’interpolation.

### `options`

**Type** [`GTStringOptions`](/docs/vue/reference/types/gt-string-options) · **Facultatif** · **Par défaut** `{}`

Seul `$context` est pris en charge. Il permet de distinguer des chaînes source identiques.

## Valeur de retour [#returns]

**Type** `string`

Renvoie la valeur de type chaîne du catalogue actif pour le hachage calculé. Si l’entrée est absente ou si la valeur du catalogue n’est pas une chaîne, renvoie `message` inchangé.

La recherche est synchrone et n’effectue aucune opération réseau, aucun traitement ICU ni aucune interpolation.

## Implémentations [#implementations]

| API                                                 | Source de l’état                                                                                                 | Mises à jour du paramètre régional                                                                                                                                                |
| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`useGT()`](/docs/vue/reference/composables/use-gt) | Le [`GTPlugin`](/docs/vue/reference/types/gt-plugin) installé dans l’application Vue actuelle.                   | Appelez le callback depuis un modèle, une valeur calculée ou un effet réactif afin de le réexécuter lorsqu’un plugin réactif change de paramètre régional ou charge un catalogue. |
| [`t()`](/docs/vue/reference/functions/t)            | Le runtime global du navigateur créé par [`initializeGTSPA()`](/docs/vue/reference/functions/initialize-gt-spa). | Les résultats définis au niveau du module ne sont mis à jour qu’après le rechargement de la page par le setter de paramètre régional de la SPA et la réévaluation des modules.    |

L’appel à [`useGT()`](/docs/vue/reference/composables/use-gt) sans plugin installé lève une exception lorsque le composable tente d’accéder à l’état. L’appel à [`t()`](/docs/vue/reference/functions/t) sur le serveur ou avant la fin de l’initialisation de la SPA lève également une exception.

## Exemple [#example]

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

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