# vue: GTFunction
URL: https://generaltranslation.com/ja/docs/vue/reference/types/gt-function.mdx
---
title: GTFunction
description: Vue のプレーン文字列カタログの参照に使用する同期コールバックについて説明します。GTFunction の API リファレンス。

---

[`useGT()`](/docs/vue/reference/composables/use-gt) が返すコールバックと、モジュールレベルの [`t()`](/docs/vue/reference/functions/t) エクスポートは、同じシグネチャを持ちます。状態の管理主体と利用可否は異なりますが、参照結果は同じです。

## 概要 [#overview]

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

| パラメータ                 | 説明                      | 型                                                                | 任意  | デフォルト |
| --------------------- | ----------------------- | ---------------------------------------------------------------- | --- | ----- |
| [`message`](#message) | 翻訳するソース文字列。             | `string`                                                         | いいえ | —     |
| [`options`](#options) | カタログハッシュで使用する任意のコンテキスト。 | [`GTStringOptions`](/docs/vue/reference/types/gt-string-options) | はい  | `{}`  |

## パラメータ [#parameters]

### `message`

**型** `string` · **必須**

プレーンな `STRING` ハッシュの計算に使用するリテラルなソーステキストです。波括弧もこのテキストの一部であり、補間用プレースホルダーではありません。

### `options`

**型** [`GTStringOptions`](/docs/vue/reference/types/gt-string-options) · **任意** · **デフォルト** `{}`

サポートされているのは `$context` のみです。同一のソース文字列を識別するために使用します。

## 戻り値 [#returns]

**型** `string`

計算されたハッシュに対応するアクティブなカタログの文字列値を返します。エントリが存在しない場合、またはカタログの値が文字列でない場合は、`message` をそのまま返します。

参照は同期的に行われ、ネットワーク処理、ICU 処理、補間は行いません。

## 実装 [#implementations]

| API                                                 | 状態の取得元                                                                                              | ロケール更新                                                                            |
| --------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| [`useGT()`](/docs/vue/reference/composables/use-gt) | 現在の Vue アプリにインストールされている [`GTPlugin`](/docs/vue/reference/types/gt-plugin)。                          | テンプレート、算出値、またはリアクティブエフェクト内でコールバックを呼び出すと、リアクティブなプラグインによるロケール変更やカタログの読み込み後に再実行されます。 |
| [`t()`](/docs/vue/reference/functions/t)            | [`initializeGTSPA()`](/docs/vue/reference/functions/initialize-gt-spa) によって作成されるブラウザグローバルの Runtime。 | モジュールレベルの結果は、SPA のロケールセッターによってページが再読み込みされ、モジュールが再評価された後にのみ更新されます。                 |

プラグインがインストールされていない状態で [`useGT()`](/docs/vue/reference/composables/use-gt) を呼び出すと、コンポーザブルが状態にアクセスしようとした際に例外がスローされます。サーバー上で、または SPA の初期化が完了する前に [`t()`](/docs/vue/reference/functions/t) を呼び出した場合も例外がスローされます。

## 例 [#example]

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

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