Format Duration

format-duration

Format a duration of time into a human-readable string.

You can use the locale option to specify the locale of the output string.

You can use the delimiter option to specify the delimiter between the parts of the duration.

You can use the formatOptions option to specify the format of the output string.

Language support

Datezone uses the Intl API under the hood, so it supports the same locales as Intl.

For duration calculations, see duration.

reference/format-duration/formatDuration.ts
import { formatDuration } from "datezone";

console.log(
	formatDuration({
		days: 1,
		hours: 12,
		minutes: 10,
		months: 1,
		seconds: 1,
		weeks: 1,
		years: 1,
	}), // 1 year 1 month 1 week 1 day 12 hours 10 minutes 1 second
);

console.log(
	formatDuration(
		{ minutes: 3, months: 5, years: 2 },
		{ delimiter: "、", locale: "zh-CN" },
	),
); // 2年、5个月、3分钟

Formatters

Edit on GitHub

On this page