ly-utils-lib 1.0.2 → 1.0.3

package/README.md

@@ -0,0 +1,248 @@
+# 自定义函数库，集成 day.js 和 es-toolkit
+
+安装：npm install dayjs es-toolkit ly-utils-lib
+
+# 时间函数
+
+## 日期格式化函数 formatDate
+
+/\*\*
+
+- 日期格式化函数
+- @param {Date | string} date - 日期
+- @param {string} format - 格式模板
+- @returns {string} 格式化后的日期字符串
+  \*/
+
+formatDate(date: Date | string = new Date(), format: string = 'YYYY-MM-DD HH:mm:ss')
+
+例：formatDate()
+
+## 日期计算函数 computeDate
+
+/\*\*
+
+- 日期计算函数
+- @param {string} compute - 计算方式 'after' | 'before'
+- @param {Date | string} date - 日期
+- @param {string} type - 计算类型 'day' | 'week' | 'month' | 'quarter' | 'year' | 'hour' | 'minute' | 'second' | 'millisecond'
+- @param {number} num - 计算数量
+- @param {string} format - 格式模板
+- @returns {string} 格式化后的日期字符串
+  \*/
+
+computeDate(compute: string = 'after', date: Date | string = new Date(), type: ManipulateType | undefined = 'day', num: number = 1, format: string = 'YYYY-MM-DD')
+
+例：computeDate('after', Date.now(), 'day')
+
+## 开始时间函数 startDate
+
+/\*\*
+
+- 开始时间函数
+- @param {string} type - 类型 'date' | 'day' | 'month' | 'quarter' | 'year' | 'week' | 'isoWeek' | 'hour' | 'minute' | 'second' | 'millisecond'
+- @param {string} format - 格式模板
+- @returns {string} 格式化后的日期字符串
+  \*/
+
+startDate(type: ManipulateType | undefined = 'month', format: string = 'YYYY-MM-DD')
+
+例：startDate('day', 'HH:mm')
+
+## 结束时间函数 endDate
+
+/\*\*
+
+- 结束时间函数
+- @param {string} type - 类型 'date' | 'day' | 'month' | 'quarter' | 'year' | 'week' | 'isoWeek' | 'hour' | 'minute' | 'second' | 'millisecond'
+- @param {string} format - 格式模板
+- @returns {string} 格式化后的日期字符串
+  \*/
+
+endDate(type: ManipulateType | undefined = 'month', format: string = 'YYYY-MM-DD')
+
+例：endDate('day', 'HH:mm')
+
+## 获取时间戳函数 getTimeStamp
+
+/\*\*
+
+- 获取时间戳函数
+- @param {Date | string} date - 日期
+- @returns {number} 时间戳
+  \*/
+
+getTimeStamp(date: Date | string = new Date())
+
+例：getTimeStamp('2025-12-31')
+
+## 时间戳格式化函数 formatTimeStamp
+
+/\*\*
+
+- 时间戳格式化函数
+- @param {number} timeStamp - 时间戳
+- @param {string} format - 格式模板
+- @returns {string} 格式化后的日期字符串
+  \*\*/
+
+formatTimeStamp(timeStamp: number = 0, format: string = 'YYYY-MM-DD HH:mm:ss')
+
+例：formatTimeStamp(1767110400, 'YYYY-MM-DD')
+
+## 获取两个日期时间之间的差异函数 getDateDiff
+
+/\*\*
+
+- 获取两个日期时间之间的差异函数
+- @param {string} type - 类型 'week' | 'day' | 'month' | 'quarter' | 'year' | 'hour' | 'minute' | 'second' | 'millisecond'
+- @param {Date | string} startDate - 起始时间
+- @param {Date | string} endDate - 结束时间
+- @returns {number} 差异值
+  \*/
+
+getDateDiff(type: OpUnitType = 'day', startDate: Date | string, endDate: Date | string = new Date())
+
+例： getDateDiff('day', '2025-12-01', '2025-12-10')
+
+## 获取一段范围内日期函数 getRangeDate
+
+/\*\*
+
+- 获取一段范围内日期函数
+- @param {Date | string} startDate - 起始时间
+- @param {Date | string} endDate - 结束时间
+- @returns {array} 日期集合
+  \*/
+
+getRangeDate(startDate: Date | string, endDate: Date | string): Array<any>
+
+例： getRangeDate('2025-12-01', '2025-12-10')
+
+## 获取相对时间函数 getRelativeTime
+
+/\*\*
+
+- 获取相对时间函数
+- @param {Date | string} date - 日期
+- @returns {string} 相对时间描述
+  \*/
+
+getRelativeTime(date: Date | string)
+
+例： getRelativeTime('2025-12-10')
+
+# 缓存函数
+
+## 设置永久缓存 setLocal
+
+/\*\*
+
+- 设置永久缓存
+- @param {string} key - 缓存名称
+- @param {string | number | object | Array<any>} value - 缓存内容
+  \*/
+
+setLocal(key: string, value: string | number | object | Array<any>)
+
+例： setLocal('key', '1234')
+
+## 获取永久缓存 getLocal
+
+/\*\*
+
+- 获取永久缓存
+- @param {string} key - 缓存名称
+- @returns {string} 格式化后的value
+  \*/
+
+getLocal(key: string)
+
+例： getLocal('key')
+
+## 移除永久缓存 removeLocal
+
+/\*\*
+
+- 移除永久缓存
+- @param {string} key - 缓存名称
+  \*/
+
+removeLocal(key: string)
+
+例： removeLocal('key')
+
+## 移除全部永久缓存 clearLocal
+
+clearLocal()
+
+例： clearLocal()
+
+## 设置临时缓存 setSession
+
+/\*\*
+
+- 设置永久缓存
+- @param {string} key - 缓存名称
+- @param {string | number | object | Array<any>} value - 缓存内容
+  \*/
+
+setSession(key: string, value: string | number | object | Array<any>)
+
+例： setSession('key', '1234')
+
+## 获取永久缓存 getSession
+
+/\*\*
+
+- 获取临时缓存
+- @param {string} key - 缓存名称
+- @returns {string} 格式化后的value
+  \*/
+
+getSession(key: string)
+
+例： getSession('key')
+
+## 移除永久缓存 removeSession
+
+/\*\*
+
+- 移除临时缓存
+- @param {string} key - 缓存名称
+  \*/
+
+removeSession(key: string)
+
+例： removeSession('key')
+
+## 移除全部临时缓存 clearSession
+
+clearSession()
+
+例： clearSession()
+
+# 工具函数
+
+## 生成UUID createUUID
+
+createUUID()
+
+例： createUUID()
+
+## 导出xlsx文件 exportExcel
+
+/\*\*
+
+- 导出xlsx文件
+- @param {string} name - 文件名称
+- @param {any} title - xlsx表头
+- @param {any} data - xlsx数据
+- @param {any} cols - xlsx宽度
+- @param {any} sheetName - xlsx页签名称
+- @returns {Promise<unknown>} 导出是否成功
+  \*/
+
+exportExcel(name: string, title: any, data: any, cols: any, sheetName: any = {})
+
+例： exportExcel('1111', { id: 'ID' }, [[{ id: 10 }, { id: 11 }]], [{ width: 20 }], ['111'])

package/dist/index.d.ts

@@ -1,3 +1,5 @@
 export { default as dayjs } from 'dayjs';
 export * from 'es-toolkit';
 export * from './utils/time';
+export * from './utils/tool';
+export * from './utils/storage';