clean-jsdoc-theme TypeDoc APIv0.0.0

formatDate

formatDate( date: string | number | Date, format: 'short' | 'medium' | 'long' | 'full', options: DateFormatOptions, ): string

Source: date.ts:68

Formats a date using Intl.DateTimeFormat

Parameters

  • date (string | number | Date) — Date to format
  • format ("short" | "medium" | "long" | "full", default: "'medium'") — Format style or options
  • options (DateFormatOptions, default: "{}") — Additional options

Returns

  • string — Formatted date string

Example

CODE
formatDate(new Date(), 'short') // '12/15/2024'
formatDate(new Date(), 'long') // 'December 15, 2024'
formatDate(new Date(), 'full', { locale: 'de-DE' }) // 'Sonntag, 15. Dezember 2024'