formatDate

Formats a Luxon DateTime as a localized calendar date with year, month, and day. It centralizes the formatting options so views can use the same date presentation without repeating Luxon configuration.

Importing

import { formatDate } from '@almighty-shogun/utils';

Usage

import { DateTime } from 'luxon';
import { formatDate } from '@almighty-shogun/utils';

const label = formatDate(DateTime.fromISO('2026-05-20'), 'en');

// 'May 20, 2026'

Parameters

date: DateTime
Date to format.

locale?: Undefinable<string>
Locale override.

Returns

A localized date string such as May 20, 2026 in English locales. The exact output depends on the locale data available in the runtime.

Uses

• Undefinable

Type signature

declare function formatDate(
    date: DateTime,
    locale?: Undefinable<string>
): string;