Format a compact duration

At a glanceCopy Anchor Link

• Who: Developers showing elapsed time next to live status or logs.
• What: Turn a millisecond span or two instants into compact 6m 17s / 1h 02m text. Digits follow the locale argument; unit letters stay Latin.
• Use when: For dense elapsed-time labels beside a live indicator or timestamp.
• Avoid when: For relative "3 minutes ago" — use UpdatedAgo. For absolute times — render a <time dateTime>.
• See also: Stamp data with its age

InstallCopy Anchor Link

pnpm add @zedtech/zedkit-ui

Latest: 2.0.1 (via changesets).

ExampleCopy Anchor Link

import { formatDuration } from "@zedtech/zedkit-ui";
formatDuration(377_000); // "6m 17s"
formatDuration(3_720_000); // "1h 02m"
formatDuration({ start: 0, end: 377_000 }, "fr"); // "6m 17s"

Wraps: (none)

AccessibilityCopy Anchor Link

Returns a plain string. Digits follow the locale; h/m/s stay Latin. The caller owns the host — this is not a live region; place it next to a live indicator, not inside one.