formatTime

The formatTime() function formats a TheTime using a custom format string.

Interactive example

Syntax

Curried signature

function formatTime<
	GenericInput extends TheTime | SerializedTheTime,
	GenericFormat extends string
>(
	formatString: GenericFormat
): (input: GenericInput) => string

Classic signature

function formatTime<
	GenericInput extends TheTime | SerializedTheTime,
	GenericFormat extends string
>(
	input: GenericInput,
	formatString: GenericFormat
): string

Parameters

• input: TheTime value (classic signature only).
• formatString: Format string.

Return value

Formatted string based on the provided tokens.

Available tokens

• WW: 2-digit weeks
• DD: 2-digit days
• HH: 2-digit hours
• mm: 2-digit minutes
• ss: 2-digit seconds
• SSS: 3-digit milliseconds

See also

• format
• toTimeValue