# formatDistance

URL: https://caijiao.org/date-fns/common-helpers/formatDistance
Source: docs/date-fns/common-helpers/formatDistance.md
Description: 返回两个日期之间的距离的描述字符串。

返回两个日期之间的距离的描述字符串。

```javascript
import { formatDistance } from "date-fns";

// 示例日期
const date1 = new Date(2024, 0, 1); // 2024年1月1日
const date2 = new Date(2024, 2, 15); // 2024年3月15日

// 格式化距离
const distance = formatDistance(date1, date2);

console.log(`日期1和日期2之间的距离为：${distance}`); // 日期1和日期2之间的距离为：2 months
```