katanakit-js / useFormat

Function: useFormat()

function useFormat(
   dateInput, 
   locale?, 
   options?
): string;

Defined in: src/core/services/dates.service.ts:590

Formats a date input into a localised string using Intl.DateTimeFormat.

Parameters

Parameter	Type	Default value	Description
dateInput	TemporalInput	undefined	The value to format.
locale	"en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh"	"en"	BCP 47 locale tag (defaults to "en").
options	DateTimeFormatOptions	{}	Intl.DateTimeFormatOptions (defaults to {}).

Returns

string

The formatted date string.

Example

useFormat("2024-06-15");