@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
16 lines (15 loc) • 560 B
TypeScript
/**
* Return the day of week (1-7) for a given ISO 8601 date string.
*
* - Monday=1 through Sunday=7.
* - Returns null for invalid input.
*
* @param value ISO date string
* @returns Day of week (1-7) or null on invalid input
*
* @example parseDayOfWeekFromDate("2024-01-01") // 1 (Monday)
* @example parseDayOfWeekFromDate("2024-01-07") // 7 (Sunday)
* @example parseDayOfWeekFromDate("2024-01-08") // 1 (Monday)
* @example parseDayOfWeekFromDate("invalid") // null
*/
export declare function parseDayOfWeekFromDate(value: string): number | null;