@acrool/js-utils/date/date.d.ts

Common javascript utils methods for project development

import { TTime } from './types';
/**
 * 格式化日期和時間
 * 此函數接受一個可選的日期字符串，並返回一個格式化的日期和時間字符串。
 * 如果日期在當前年份，則僅顯示月和日；否則顯示完整的年、月、日。
 * 時間部分始終以 'HH:mm' 格式顯示。
 * 如果輸入的日期字符串無效或者為空，則返回空字符串。
 *
 * @param {string|null} [dateString] - 可選的日期字符串
 * @returns {string} 格式化的日期和時間字符串，或者在無效的輸入時返回空字符串
 */
export declare function simpleDateTime(dateString?: string | null): string;
/**
 * 簡化顯示日期
 * 此函數接受一個可選的日期字符串，並根據是否與當前年份相同返回不同的日期格式。
 * 如果日期與當前年份相同，則以 'MM/DD' 的格式返回；
 * 如果不同，則以 'YYYY/MM/DD' 的格式返回。
 * 如果輸入的日期字符串無效、為空或者只包含空格，則返回空字符串。
 *
 * @param {string|null} [dateString] - 可選的日期字符串
 * @returns {string} 格式化後的日期字符串，或者在無效的輸入時返回空字符串
 */
export declare function simpleDate(dateString?: string | null): string;
/**
 * 獲得日期範圍的簡化表示
 * 此函數接受兩個日期字符串作為起始和結束日期，並返回一個表示這段日期範圍的格式化字符串。
 * 如果只有一個有效日期或兩個日期相同，則只返回該日期的簡化表示。
 * 如果起始和結束日期在同一年，則以 'MM/DD' 的格式顯示兩個日期。
 * 如果不在同一年，則兩個日期都以 'YYYY/MM/DD' 的格式顯示。
 * 如果任一輸入的日期字符串無效、為空或者只包含空格，則返回空字符串。
 *
 * @param {string|null} [startDate] - 起始日期字符串
 * @param {string|null} [endDate] - 結束日期字符串
 * @returns {string} 格式化的日期範圍字符串，或者在無效的輸入時返回空字符串
 */
export declare function rangeSimpleDate(startDate?: string | null, endDate?: string | null): string;
/**
 * formatTotalSeconds 總秒數轉換時間物件
 * @param totalSeconds 總秒數
 * @param isCountDays 是否計算天數
 * @returns 時間物件 {天?, 時, 分, 秒}
 */
export declare const formatTotalSeconds: (totalSeconds: number, isCountDays?: boolean) => TTime;
/**
 * formatTimeToString 總秒數轉換時間戳字串
 * @param totalSeconds 總秒數
 * @param isVisibleMinimumUnitOnly 是否只顯示最小單位 (ex: 00:10:20 只顯示 10:20)
 * @returns 時間戳格式 時：分：秒
 */
export declare const formatSecondToString: (totalSeconds: number, isVisibleMinimumUnitOnly?: boolean) => string;
/**
 * 毫秒轉秒數
 * @param millisecond 毫秒
 * @param isDecimal 是否保留小數
 */
export declare const millisecondToSeconds: (millisecond: number, isDecimal?: boolean) => number;
/**
 * 分鐘轉毫秒
 * @param minute 分數
 */
export declare const minuteToMillisecond: (minute: number) => number;
/**
 * 小時轉毫秒
 * @param hour 小時
 */
export declare const hourToMillisecond: (hour: number) => number;
/**
 * 天轉毫秒
 * @param day
 */
export declare const dayToMillisecond: (day: number) => number;