---
url: /api/renderers/web-components/src/functions/formatRelativeTime.md
---
[pantoken-root](../../../../index.md) / [renderers/web-components/src](../index.md) / formatRelativeTime

# Function: formatRelativeTime()

> **formatRelativeTime**(`locale`, `value`, `unit`, `options?`): `string`

Alpha

A locale-bound relative-time formatter (e.g. `"3 days ago"`).

## Parameters

### locale

`string`

### value

`number`

### unit

`RelativeTimeFormatUnit`

### options?

`RelativeTimeFormatOptions`

## Returns

`string`