Skip to main content

FormatTimeOptions

Options for FormatTime function to control how time is formatted.

Properties​

hours?​

optional hours: "never" | "auto" | "always";

Controls the hours segment:

  • 'never' (default) — always renders as "M:SS", e.g. "5:30"
  • 'auto' — includes hours only when duration ≥ 1 h, e.g. "1:02:05"
  • 'always' — always includes hours even when 0, e.g. "0:05:30"

padMinutes?​

optional padMinutes: boolean;

When true, pads the minutes segment to two digits (e.g. "01:30" instead of "1:30"). Useful for timer displays where consistent character width matters. Defaults to false.