Docebo libraries documentation site
vdevelop
Get Started
Guides
Overview Icons Illustrations Theme
Components
Accordion Avatar Badge Alert Badge Icon Badge Status Blank Slate Button Calendar Card Carousel Chip Data Browser Expandable Content Facet List
Filters
Filter Filter Container Filter Multiple Selection Filter Single Selection Filter Slider Range Selection Filter Slider Selection
Helper Message Icon Illustration
Inputs
Input Autocomplete Input Checkbox Input Checkbox Group Input Combobox Input Date Input Password Input Radio Group Input Rating Input Search Input Select Input Slider Input Text Input Toggle Input Upload
Link List List Listbox List Navigation List Presentation List Sheet List Tablist List Tree Menu Modal Dialog Navigation Notification Pagination Bar Popover Progress Skeleton Stepper Table Toast Tooltip
API References
@elemental/common / Function

formatTime

Given a duration expressed as milliseconds, it returns the duration formatted as an hms string.

Presentation

function formatTime(
  milliseconds: number,
  as: "time" | "extended-time" | "full-time",
  dropBlankUnits: boolean = true,
): string;

Returns

string -

The formatted duration.

Parameters

NameTypeDescription
milliseconds
number

@param milliseconds The number of milliseconds.

as
"time" | "extended-time" | "full-time"

@param as Whether to format it as a time (i.e. "4h 5m 29s") or an extended time (i.e. "4 hours 5 minutes 29 seconds").

dropBlankUnits
boolean

@param dropBlankUnits Whether to drop leading and trailing blank units.