@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
23 lines (22 loc) • 1.13 kB
TypeScript
/**
* Format a UTC ISO 8601 datetime string as an RFC 7231 IMF-fixdate — the
* fixed grammar HTTP headers like `Last-Modified`/`Date`/`Expires` require.
*
* - **Fixed grammar, not a display format.** RFC 7231 mandates English
* weekday/month abbreviations and a literal `GMT` suffix regardless of
* caller locale — there is no locale-appropriate alternative ordering to
* lose (see roadmap `issues/J.md` Decision 1 / J13).
* - Always `GMT`; HTTP-date carries no offset variation to preserve.
* - Fractional seconds in `value` are truncated — IMF-fixdate has no
* sub-second field.
* - Day, hour, minute, and second are always zero-padded to 2 digits; year
* is zero-padded to 4 digits.
*
* @param value UTC ISO 8601 datetime string (e.g. "2024-03-15T14:30:00Z")
* @returns RFC 7231 IMF-fixdate string, or "" on invalid input
*
* @example formatHttp("2024-03-15T14:30:00Z") // "Fri, 15 Mar 2024 14:30:00 GMT"
* @example formatHttp("2024-03-15T14:30:00.500Z") // "Fri, 15 Mar 2024 14:30:00 GMT"
* @example formatHttp("invalid") // ""
*/
export declare function formatHttp(value: string): string;