tfl-ts/dist/utils/format.d.ts

🚇 Fully-typed TypeScript client for Transport for London (TfL) API • Zero dependencies • Auto-generated types • Real-time arrivals • Journey planning • Universal compatibility

/**
 * Utility functions for formatting distance and time values
 * Used across journey planning, natural language generation, and demo files
 */
/**
 * Format distance in meters to a human-readable string
 *
 * @param meters - Distance in meters
 * @returns Formatted distance string
 * @example
 * formatDistance(3153) // "3,153m"
 * formatDistance(1000) // "1,000m"
 * formatDistance(500)  // "500m"
 */
export declare function formatDistance(meters: number): string;
/**
 * Format duration in minutes to a human-readable string
 *
 * @param minutes - Duration in minutes
 * @returns Formatted duration string
 * @example
 * formatDuration(90)  // "1 hour 30 minutes"
 * formatDuration(60)  // "1 hour"
 * formatDuration(45)  // "45 minutes"
 * formatDuration(1)   // "1 minute"
 */
export declare function formatDuration(minutes: number): string;
/**
 * Format a date for display (shows "today" if it's today, otherwise full date)
 *
 * @param dateString - ISO date string
 * @returns Formatted date string
 * @example
 * formatDateForDisplay('2025-07-10T00:59:00') // "today" or "10 July 2025"
 */
export declare function formatDateForDisplay(dateString: string): string;
/**
 * Format a time for display (12-hour format with am/pm)
 *
 * @param dateString - ISO date string
 * @returns Formatted time string
 * @example
 * formatTimeForDisplay('2025-07-10T00:59:00') // "12:59am"
 */
export declare function formatTimeForDisplay(dateString: string): string;
/**
 * Format a date and time combination for display
 *
 * @param dateString - ISO date string
 * @returns Formatted date and time string
 * @example
 * formatDateTimeForDisplay('2025-07-10T00:59:00') // "today 12:59am" or "10 July 2025 12:59am"
 */
export declare function formatDateTimeForDisplay(dateString: string): string;