# generaltranslation: General Translation Core SDK: formatRelativeTime
URL: https://generaltranslation.com/ja/docs/core/class/methods/formatting/format-relative-time.mdx
---
title: formatRelativeTime
description: 相対時間の値を整形する formatRelativeTime メソッドの API リファレンス
---

## 概要

`formatRelativeTime` メソッドは、明示的に指定した単位を使って、相対時間の値をロケール固有の規則に従ってフォーマットします。

```typescript
const gt = new GT();
const formatted = gt.formatRelativeTime(-1, 'day', {
  locales: 'en-US',
  numeric: 'auto'
});
// 戻り値: "yesterday"
```


## リファレンス

### パラメータ

| 名前         | 型                             | 説明                                                                          |
| ---------- | ----------------------------- | --------------------------------------------------------------------------- |
| `value`    | `number`                      | 相対時間の値 (過去は負の値、未来は正の値)                                                      |
| `unit`     | `Intl.RelativeTimeFormatUnit` | 時間の単位 (`'second'`、`'minute'`、`'hour'`、`'day'`、`'week'`、`'month'`、`'year'`)  |
| `options?` | `object`                      | 書式設定オプション                                                                   |

### オプション

| 名前               | 型                               | 説明                                                   |
| ---------------- | ------------------------------- | ---------------------------------------------------- |
| `locales?`       | `string \| string[]`            | 書式設定に使用するロケール。未指定の場合は、インスタンスのレンダリング時のロケールにフォールバックします |
| `numeric?`       | `'always' \| 'auto'`            | 常に数値形式の出力を使用するかどうか。デフォルトは `'auto'`                   |
| `style?`         | `'long' \| 'short' \| 'narrow'` | 出力の長さ。デフォルトは `'long'`                                |
| `localeMatcher?` | `'best fit' \| 'lookup'`        | 使用するロケール照合アルゴリズム                                     |

### 戻り値

`string` - 書式設定された相対時間文字列。

***

## 例

```typescript copy
import { GT } from 'generaltranslation';
const gt = new GT();

// 過去の時間
gt.formatRelativeTime(-2, 'hour', { locales: 'en-US' });
// 戻り値: "2 hours ago"

// 未来の時間
gt.formatRelativeTime(3, 'day', { locales: 'fr-FR' });
// 戻り値: "dans 3 jours"

// numeric: 'auto' を使用（デフォルト）
gt.formatRelativeTime(-1, 'day', { locales: 'en-US' });
// 戻り値: "yesterday"
```

***

## 注記

* デフォルト値は `numeric: 'auto'` と `style: 'long'` です
* 内部的に [`Intl.RelativeTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat) を使用します

## 次のステップ

* `Date` から単位を自動選択するには、[`formatRelativeTimeFromDate`](/docs/core/class/methods/formatting/format-relative-time-from-date) を参照してください
* GT インスタンスを作成せずに使用するには、スタンドアロンの [`formatRelativeTime`](/docs/core/functions/formatting/format-relative-time) 関数を参照してください