feat(dt-utils): refactor the dt-utils #105

jin-sir · 2025-06-22T17:29:52Z

变更类型

请选择以下选项以描述 PR 的类型：

Bug 修复（修复现有问题）
新功能（添加了一个功能）
代码优化（性能改进、代码重构）
文档更新
单测新增或修改
其他（请说明）：

变更内容

优化

browserCheck
- 更名 checkBrowserSupport
- 使用 ua-parser-js 获取浏览器信息
- 版本对比精确到小版本
copy
- 使用 Promise 替换 callback
- 优先使用 navigator.clipboard
downLoadData
- 更名 downloadFile
- 使用 Promise 替换 callback，且将 Response 作为参数传递
convertBytes
- 更名 formatBytes
- 新增 decimals 参数，控制小数位数
- 优化计算逻辑
generateAKey、getRandomStr
- 合并并命名为 getKey
- 使用 nanoid 生成 key
generateFullUrlPath
- 更名 generateUrlWithQuery
- 新增 object 和 array 参数的处理：将对象转换为 JSON 字符串
getQueryParameters
- 兼容 generateFullUrlPath ，新增 object 和 array 的解析
isMacOs
- 更名 isMacOS
- 使用 ua-parser-js 判断
isWindows
- 使用 ua-parser-js 判断
isMobileDevice
- 更名 isMobile
- 使用 http://detectmobilebrowsers.com/
localDB
- set 支持批量添加
- clear 支持保留部分 key
dateTime
- 删除 dateTime 中的所有函数，新增 formatDateTime
- formatDateTime 支持将传入的时间根据传入的格式进行格式化
- 同时提供 DayjsFormat 枚举，其中包含了常见的时间格式，方便使用
getBase64、base64Encode
- 合并为 toBase64
- 非文件使用 js-base64 进行编码
percent
- 更名 toPercent
- 放开最大值 1 的限制
exchangeOrder
- 更名 toSortOrder
getThousandth
- 更名 toThousand

新增

formatSecond
- 格式化秒数：3661 -> 1h1m1s
fromBase64
- 从 js-base64 导出，解码 base64 字符串
getTypeOfValue
- 获取传入的值的类型
sessionDB
- 功能同 localDB

对应 Previewer

https://jin-sir.github.io/dt-utils/

… parameter

…TypeDoc

src/generateUrlWithQuery/index.ts

src/getKey/index.ts

src/getTypeOfValue/index.ts

LuckyFBB

想到一个问题，这个里面有些 console 是用中文写的，可能源码合并到产品里面之后，中文校验不通过

LuckyFBB · 2025-08-22T09:06:43Z

src/generateUniqueId/index.ts

@@ -0,0 +1,28 @@
+import { nanoid } from 'nanoid';


这个是否需要单元测试啊

LuckyFBB · 2025-08-22T09:08:59Z

src/index.ts

+export { default as dayjs } from 'dayjs';
+export * as idb from 'idb';
+export { default as Cookie } from 'js-cookie';
+export * as lodash from 'lodash-es';


这些是为了以后大家都走 utils 引入吗？

LuckyFBB · 2025-08-22T09:10:38Z

src/indexedDB/index.ts

+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB|MDN IndexedDB 使用指南}
+ * @see {@link https://caniuse.com/#feat=indexeddb|浏览器兼容性}
+ */
+class IndexedDB {


这个单元测试需要吗？

LuckyFBB · 2025-08-22T09:11:03Z

src/indexedDB/index.ts

+/**
+ * IndexedDB
+ *
+ * @deprecated


是打了移除标记吗？

liuxy0551 · 2025-08-27T07:48:14Z

docs/.vitepress/config.mts

+                text: 'Guide',
+                items: [
+                    { text: 'Quick Start', link: '/quickstart' },
+                    { text: 'contribution', link: '/contribution' },


contribution 开头应该大写，和其他不统一了。另外这里是不是可以都改成中文的，因为下方方法的目录名称也都是中文

liuxy0551 · 2025-08-27T08:31:40Z

docs/api/classes/IndexedDB.md

+
+# Class: ~~IndexedDB~~
+
+Defined in: [indexedDB/index.ts:37](https://github.com/DTStack/dt-utils/blob/main/src/indexedDB/index.ts#L37)


Defined in 的地址好像都为 main 分支，应该改为 master。另外这个地址是手动维护的吧，后续如果在定义方法的那一行之前添加其他内容，似乎还得修改这里的 Defined 链接

liuxy0551 · 2025-08-27T08:39:16Z

docs/contribution.md

@@ -22,7 +22,7 @@

 1、请 `fork` 本项目，`clone` 自己的仓库，按照上述分支定义从 `master` 分支新建 `feat` 分支进行开发，分支命名用下划线加上版本号、功能名，如：`feat_1.x_xxx`

-2、`feat` 分支开发完毕后，本地执行 `yarn lint` 命令，再执行 `yarn test` 命令，均通过后向相应人员提 PR，期望合入 `release` 分支，待相应人员 review 代码后合入
+2、`feat` 分支开发完毕后，本地执行 `pnpm lint` 命令，再执行 `pnpm test` 命令，均通过后向相应人员提 PR，期望合入 `release` 分支，待相应人员 review 代码后合入


release 分支基本不用，可以根据实际情况编辑下分支规则

liuxy0551 · 2025-08-27T08:46:20Z

src/indexedDB/index.ts

+ *
+ * @example
+ * ```typescript
+ * import { LocalIndexedDB } from 'dt-utils';


全局搜 LocalIndexedDB，还残留有四处，应更名为 IndexedDB，记得使用 rebase 到 rename 那个 commit

liuxy0551 · 2025-08-27T08:50:51Z

src/localIndexedDB/index.ts

+/**
+ * LocalIndexedDB
+ *
+ * @deprecated


为啥废弃，是因为想要直接用第三方包吗，会影响文档

liuxy0551 · 2025-08-28T02:55:13Z

docs/api/functions/formatDateTime.md

+
+### format
+
+`string` = `DateTimeFormat.STANDARD`


可以链接一下 DateTimeFormat 的内容有哪些

liuxy0551 · 2025-08-28T02:59:30Z

docs/api/functions/formatSecond.md

+
+Defined in: [formatSecond/index.ts:28](https://github.com/DTStack/dt-utils/blob/main/src/formatSecond/index.ts#L28)
+
+将秒数转换为时间格式 (HH[h]mm[m]ss[s])


是否可以支持传入 h, m, s 这三个单位，比如有些地方需要展示为 18分26秒 或 运行时长：03:21:18

HH:mm:ss 是带 0 的，也就是 02h21m18s 这种形式。看是要改文档，还是说要支持传入 format

liuxy0551 · 2025-08-28T03:49:40Z

src/isMacOS/index.ts

+    const parser = new UAParser();
+    const result = parser.getOS();
+
+    return result.name === 'macOS';


Mac 和 Windows 都需要实际测一下，目前这里判断 name === 'macos' 是不对的

源码：https://github.com/faisalman/ua-parser-js/blob/1.0.x/src/ua-parser.js

liuxy0551 · 2025-08-28T05:40:04Z

docs/api/functions/fromBase64.md

+
+`string`
+
+— Base64 字符串。支持标准格式和 URL 安全格式


这个 — 是中文的吧，没渲染成功

liuxy0551 · 2025-08-28T05:40:23Z

docs/api/functions/fromBase64.md

+
+`string`
+
+— UTF-8 字符串


开头的这个 — 是中文的吧，没渲染成功

liuxy0551 · 2025-08-28T05:58:17Z

这个 commit 的内容好像不太对，似乎是把改文档路径的内容也提进去了

jin-sir added 29 commits June 23, 2025 00:48

chore: upgrade package & replace packaging tools

50d84ab

refactor: remove old functions

9131eef

refactor: rename browserCheck to checkBrowserSupport

82a4a25

refactor: improve copy

9963d6a

refactor: rename downLoadData to downloadFile

5f4b0bd

refactor: rename convertBytes to formatBytes

58a28e5

refactor: rename dateTime to formatDateTime

49bc19b

feat: add formatSecond

492de08

feat: add formatBase64

7157840

refactor: rename generateFullUrlPath to generateUrlWithQuery

bc628b4

refactor: merge generateAKey and getRandomStr into getKey

ee4e777

refactor: improve getQueryParameters

8530435

feat: add getTypeOfValue

5cff92d

refactor: improve isMacOS

56ba7cc

refactor: improve isMobile

1705964

refactor: improve isWindows

8df8b0e

refactor: localDB.set support batch set, localDB.clear support except…

d8eb0bd

… parameter

refactor: improve LocalIndexedDB

d35ca34

feat: add sessionDB

1744d5b

feat: add shouldRender

3166fec

refactor: merge getBase64 and base64Encode into toBase64

c20cf9d

refactor: rename percent to toPercent

a2774db

refactor: rename exchangeOrder to toSortOrder

4dea50d

refactor: rename getThousandth to toThousand

20c180a

feat: add unit testing

fb7148e

chore: add entry file

3f9cee2

chore: remove docs

f5e2bf1

refactor: build site with VitePress and generate documentation using …

44587fe

…TypeDoc

chore: add docs:deploy script

2e8f0a5

jin-sir requested a review from liuxy0551 June 23, 2025 02:58

LuckyFBB reviewed Jun 27, 2025

View reviewed changes

src/generateUrlWithQuery/index.ts Show resolved Hide resolved

src/getKey/index.ts Outdated Show resolved Hide resolved

src/getTypeOfValue/index.ts Show resolved Hide resolved

jin-sir added 7 commits July 29, 2025 09:53

chore: replace yarn with pnpm

b766ac0

refactor: rename LocalIndexedDB to IndexedDB

2aa1db3

refactor: improve code

853ef05

chore: translate English comments to Chinese

00c11ed

chore: update project configuration and set TypeScript package version

c80bde9

chore: update docs

698f9d0

Merge remote-tracking branch 'origin/master' into feat_utils

77ce923

jin-sir force-pushed the feat_utils branch 16 times, most recently from d8de76a to f9fb886 Compare August 11, 2025 04:11

chore: replace yarn with pnpm

94aba92

jin-sir force-pushed the feat_utils branch from f9fb886 to 94aba92 Compare August 11, 2025 04:25

refactor: rename getKey to generateUniqueId

fb73a55

LuckyFBB reviewed Aug 22, 2025

View reviewed changes

liuxy0551 reviewed Aug 28, 2025

View reviewed changes


		# Class: ~~IndexedDB~~

		Defined in: [indexedDB/index.ts:37](https://github.com/DTStack/dt-utils/blob/main/src/indexedDB/index.ts#L37)


		Defined in: [formatSecond/index.ts:28](https://github.com/DTStack/dt-utils/blob/main/src/formatSecond/index.ts#L28)

		将秒数转换为时间格式 (HH[h]mm[m]ss[s])


		`string`

		— Base64 字符串。支持标准格式和 URL 安全格式

feat(dt-utils): refactor the dt-utils #105

Are you sure you want to change the base?

feat(dt-utils): refactor the dt-utils #105

Uh oh!

Conversation

jin-sir commented Jun 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

变更类型

相关问题

变更内容

优化

新增

对应 Previewer

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LuckyFBB left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

liuxy0551 commented Aug 28, 2025

Uh oh!

Uh oh!

jin-sir commented Jun 22, 2025 •

edited

Loading