export type FormatTimeParams = /** * The format string using tokens. * * Tokens: * - HH: 24-hour hour (00-23) * - H: 24-hour hour (0-23) * - hh: 12-hour hour (01-12) * - h: 12-hour hour (1-12) * - mm: 2-digit minute (00-59) * - m: minute (0-59) * - ss: 2-digit second (00-59) * - s: second (0-59) * - SSS: 3-digit millisecond (000-999) * - A: AM/PM * - a: am/pm * - [text]: Escaped literal text */ string | "HH:mm:ss" | "HH:mm" | "hh:mmA" | "hh:mm:ssA" | "HH:mm:ss.SSS"; /** * Formats a given date object, string, or timestamp into a specified time format. * * @param date The date to format (Date object, ISO string, or timestamp). * @param format The format string using tokens. Defaults to "hh:mmA". * @returns A string representing the formatted time. * * @example * formatTime(new Date(), "HH:mm:ss") // "14:30:05" * formatTime(Date.now(), "h:mm a") // "2:30 pm" * formatTime(null, "[Current time is] HH:mm") // "Current time is 14:30" */ export declare function formatTime(date?: Date | string | number | null, format?: FormatTimeParams): string;