格式化日期时间函数（Handle Time）

概述

handelTime 函数用于将输入的日期时间值格式化为指定格式的字符串。

版权信息

版权所有 © 2024 xxm

函数签名

/**
 * 此函数用于格式化日期时间值为指定格式的字符串。
 * 支持输入字符串、日期对象或时间戳作为日期时间值。
 * 支持多种日期时间格式，如 'yyyy-MM-dd', 'HH:mm:ss' 等。
 * 如果输入无效，将返回空字符串。
 * 
 * @param {string | Date | number} cellValue - 输入的日期时间值，可以是字符串、日期对象或时间戳。
 *        - 若为字符串，需符合日期格式，如 '2024-01-01' 或 '2024/01/01 12:00:00'。
 *        - 若为日期对象，即 `new Date()` 创建的对象。
 *        - 若为时间戳，是自 1970 年 1 月 1 日 00:00:00 UTC 以来的毫秒数。
 * @param {string} [format='yyyy-MM-dd'] - 期望的日期时间格式字符串，包含 'yyyy', 'MM', 'dd', 'HH', 'mm', 'ss' 等占位符。
 *        - 'yyyy' 表示四位数的年份，如 2024。
 *        - 'yy' 表示两位数的年份，如 24。
 *        - 'MM' 表示两位数的月份，范围 01 - 12。
 *        - 'M' 表示一位数或两位数的月份，范围 1 - 12。
 *        - 'dd' 表示两位数的日期，范围 01 - 31。
 *        - 'd' 表示一位数或两位数的日期，范围 1 - 31。
 *        - 'HH' 表示两位数的小时，范围 00 - 23。
 *        - 'H' 表示一位数或两位数的小时，范围 0 - 23。
 *        - 'mm' 表示两位数的分钟，范围 00 - 59。
 *        - 'm' 表示一位数或两位数的分钟，范围 0 - 59。
 *        - 'ss' 表示两位数的秒数，范围 00 - 59。
 *        - 's' 表示一位数或两位数的秒数，范围 0 - 59。
 * @returns {string} - 格式化后的日期时间字符串，如果输入无效则返回空字符串。
 * @throws {Error} - 当输入的日期格式无法解析时，会在控制台输出错误信息 'Invalid date format:' 并返回空字符串。
 */
export function handelTime(cellValue: string | Date, format: string = 'yyyy-MM-dd'): string;

参数

• cellValue: 输入的日期时间值，可以是字符串、日期对象或时间戳。 - 若为字符串，需符合日期格式，如 '2024-01-01' 或 '2024/01/01 12:00:00'。 - 若为日期对象，即 new Date() 创建的对象。 - 若为时间戳，是自 1970 年 1 月 1 日 00:00:00 UTC 以来的毫秒数。
• format (可选): 期望的日期时间格式字符串，默认为 'yyyy-MM-dd'。支持的占位符包括 'yyyy', 'MM', 'dd', 'HH', 'mm', 'ss' 等。 'yyyy' 表示四位数的年份，如 2024。 'yy' 表示两位数的年份，如 24。 'MM' 表示两位数的月份，范围 01 - 12。 'M' 表示一位数或两位数的月份，范围 1 - 12。 'dd' 表示两位数的日期，范围 01 - 31。 'd' 表示一位数或两位数的日期，范围 1 - 31。 'HH' 表示两位数的小时，范围 00 - 23。 'H' 表示一位数或两位数的小时，范围 0 - 23。 'mm' 表示两位数的分钟，范围 00 - 59。 'm' 表示一位数或两位数的分钟，范围 0 - 59。 'ss' 表示两位数的秒数，范围 00 - 59。 's' 表示一位数或两位数的秒数，范围 0 - 59。

返回值

• 返回格式化后的日期时间字符串。

示例用法

const time = new Date();
const formatTime1 = handelTime(time); // 使用默认格式
const formatTime2 = handelTime(time, 'yyyy-MM-dd'); // 指定格式

适用场景

• 日期时间显示：在用户界面上需要以特定格式显示日期时间。
• 数据处理：在处理和存储日期时间数据时，需要将其转换为统一的格式。

总结

• 格式化日期时间函数是一个实用的工具，它可以帮助我们将日期时间值转换为易于阅读和处理的字符串格式，满足不同的显示和存储需求。

引入

• 要在使用的项目中使用 handelTime 函数，您可以单独引入：

import { handelTime } from 'xxm-test-js';

贡献

• 希望这个文档对你有所帮助！如果有任何问题或需要进一步的信息，请随时联系。