@gez/date-time-kit

date-time-kit

📌 简介

date-time-kit是一个功能强大且易于使用的 TypeScript 库，旨在解决 [web前端 时间区间选择] 的问题。它适用于 [所有web环境]，并提供高效、轻量级的解决方案。

✨ 特性

• 🚀 特性 1 - js原生开发，不依赖任何第三方框架
• 🎯 特性 2 - 非常小 仅需几十kb
• 📦 特性 3 - 提供国际化，时区控制，精确到毫秒
• 🔥 适用于浏览器
• ✅ 易于集成，支持 TypeScript

📦 安装

使用 npm 安装：

npm install @gez/date-time-kit

使用 yarn 安装：

yarn add @gez/date-time-kit

🚀 快速开始

在 ES6 环境中使用

import { open } from 'date-time-kit';

const result = awiat open({
    root: document.getElementById('root')
});
console.log(result);

📖 API 文档

open(option):kitResult

打开日历选择窗口

• option (kitOption): 初始化对象

   export interface kitOption {
          root: HTMLElement,
          // default select
          startTime?: timeString, 
          endTime?: timeString,
          // default limit
          maxTime?: timeString,
          minTime?: timeString,
          // default lang
          lang?: lang, // zhCN, enUS ...
          // default time zone
          timeZone?: number // -12 - 12
      }
  export type timeString = `${number}-${number}-${number}T${number}:${number}:${number}:${number}`;
  

• 返回值: kitResult

      export interface kitResult {
          startTime: timeString,
          endTime: timeString,
          // time stamp
          startTimeStamp: number,
          endTimeStamp: number,
          quick: kitDataLimit | null,
          timeZone: number
      }
  
  

示例：

import dataTimeKit from '@gez/date-time-kit';

const result = awiat dataTimeKit.open({
    root: document.getElementById('root')
});
console.log(result);

getLimitKeyByTimestamp(startTimestamp: timeString, endTimestamp: timeString, timeZone: number | undefined): kitDataLimit | null

通过时间段获取返回快速选择的时间

• startTimestamp: '2025-06-14T05:59:59.999'
• endTimestamp: '2025-06-13T06:00:00.000'
• timeZone: -12-12 默认当前时区
• 返回值 kitDataLimit 'today' | 'yesterday' | 'week' | 'lastWeek' | 'last7Days' | 'month' | 'last30Days' | 'last180Days' | 'last6Month' | 'year'

getTimestampByLimitKey(limitKey: kitDataLimit, timeZone: number | undefined): kitTimestampResult

通过快速选择的字段获取时间段

getCurrentTimeZone():number

获取当前时区

getDateByTimeZone(date: Date, targetTimeZone: number | undefined, currentTimeZone?: number | undefined): Date

将一个时区的时间转为另一个时区的时间 第三个参数不传默认当前时区

类型：

export type kitDataLimit = 'all' | 'today' | 'yesterday' | 'week' | 'lastWeek' | 'last7Days' | 'month' | 'last30Days' | 'last180Days' | 'last6Month' | 'year';

export interface kitTimestampResult {
    startTime: timeString,
    endTime: timeString,
    startTimeStamp: number,
    endTimeStamp: number
}

💡 示例代码

const result = await dataTimeKit.open({
    root: document.getElementById('root'),
    maxTime: "1990-01-01T00:00:00.000",
    minTime: "2050-01-01T00:00:00.000",
    startTime: "1990-01-01T00:00:00.000",
    endTime: "2050-01-01T00:10:10.022",
    enableZone: false,
    granularity:  dataTimeKit.Granularity.second,
    timeZone: 4
});
console.log(result);

🛠️ 贡献

欢迎贡献代码！请阅读 贡献指南 以了解如何提交 PR 或报告问题。

📄 许可证

本项目基于 MIT 许可证 进行发布。

📬 联系

如果你有任何问题或建议，请随时在 GitHub Issues 提交反馈，或通过 [e-mail] 联系我们。

⭐️ 如果你觉得这个项目有用，欢迎给个 Star 支持我们！