jinbi-utils 1.0.15 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +49 -49
- package/README.md +189 -189
- package/dist/chunk-optimizer.cjs +1 -2
- package/dist/index.esm.js +496 -1030
- package/dist/index.esm.min.js +2 -2
- package/dist/index.umd.js +509 -1033
- package/dist/index.umd.min.js +2 -2
- package/package.json +109 -109
- package/types/index.d.ts +0 -1
- package/types/middleware/requestLogger.middware.d.ts +24 -4
- package/types/middleware/requestLoggerUnified.d.ts +27 -0
- package/types/utils/curl.d.ts +20 -0
- package/dist/chunk-optimizer.cjs.map +0 -1
- package/dist/chunk-optimizer.min.cjs +0 -2
- package/dist/chunk-optimizer.min.cjs.map +0 -1
- package/types/ws-frontend/index.d.ts +0 -14
- package/types/ws-frontend/node-websocket-client.d.ts +0 -144
- package/types/ws-frontend/node-websocket-service.d.ts +0 -102
- package/types/ws-frontend/node-websocket-types.d.ts +0 -135
- package/types/ws-frontend/websocket-service.d.ts +0 -86
- package/types/ws-frontend/websocket-types.d.ts +0 -71
- package/types/ws-frontend/websocket.d.ts +0 -111
package/CHANGELOG.md
CHANGED
|
@@ -1,49 +1,49 @@
|
|
|
1
|
-
# Changelog
|
|
2
|
-
|
|
3
|
-
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
|
-
|
|
5
|
-
### [1.0.15](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.14...v1.0.15) (2025-12-04)
|
|
6
|
-
|
|
7
|
-
### [1.0.14](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.13...v1.0.14) (2025-12-04)
|
|
8
|
-
|
|
9
|
-
### [1.0.13](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.12...v1.0.13) (2025-12-04)
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
### ✨ Features
|
|
13
|
-
|
|
14
|
-
* 更新-apiBuilder ([5f09e35](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/5f09e357cc8e306daacdd0f33599472cf2375b14))
|
|
15
|
-
* upateAPIbuilder ([482f2e1](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/482f2e100a49d167e4c5129cacd496fc85223567))
|
|
16
|
-
* upateAPIbuilder ([42a1f40](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/42a1f40a0606a3240726b4227155758950b4f722))
|
|
17
|
-
|
|
18
|
-
### [1.0.12](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.11...v1.0.12) (2025-11-17)
|
|
19
|
-
|
|
20
|
-
### [1.0.11](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.10...v1.0.11) (2025-11-11)
|
|
21
|
-
|
|
22
|
-
### [1.0.10](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.9...v1.0.10) (2025-11-11)
|
|
23
|
-
|
|
24
|
-
### [1.0.9](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.2...v1.0.9) (2025-11-11)
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
### ✨ Features
|
|
28
|
-
|
|
29
|
-
* **build:** 新增依赖分类与分块优化功能(Chunk Optimizer) ([21c2d1a](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/21c2d1abb41c62b73bb2820a6132b3ffe027c086))
|
|
30
|
-
* **build:** 新增依赖分类与分块优化功能(Chunk Optimizer) ([1a3113d](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/1a3113dee7d8e7f67a7e48d9c6976514fbfd5297))
|
|
31
|
-
* 提交 saas平台项目需要的方法 ([e9bdefd](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/e9bdefd14d8d3006df3ff0e144321b2abf858444))
|
|
32
|
-
* 新增 `ApiBuilder` 工具类 ([62bc47e](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/62bc47eb18f3f54495239ecd0cb40e0a78c3899a))
|
|
33
|
-
|
|
34
|
-
### [1.0.2](https://e.coding.net/jinbicloud/P8/jbwy-utils/compare/v1.0.1...v1.0.2) (2025-07-31)
|
|
35
|
-
|
|
36
|
-
### [1.0.1](https://e.coding.net/jinbicloud/P8/jbwy-utils/compare/v1.0.0...v1.0.1) (2025-07-25)
|
|
37
|
-
|
|
38
|
-
## 1.0.0 (2025-07-25)
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
### ✨ Features
|
|
42
|
-
|
|
43
|
-
* 1.调整日志中间件 接入的服务地址 ([5bf17c3](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/5bf17c3ada3ec825c7dc8ac1f1cae74e1ea54e76))
|
|
44
|
-
* 1.新增 nodejs 日志中间件工具库 2. 新增iam工具库 ([07a48c8](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/07a48c87cb061401aadca3026a7821ee6f0b8069))
|
|
45
|
-
* 更新版本和依赖项 ([1bcc026](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/1bcc026a8d2c8019180e0418bde7bef485ade566))
|
|
46
|
-
* 删除 wecom 模块及相关文档 ([6ef1215](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/6ef12157d1b7ff4b4bd1217a34fcca5af49bc3e2))
|
|
47
|
-
* 添加版本控制配置和更新依赖项 ([cfecef1](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/cfecef19fff25fb167ae251246ee268d9caaaa22))
|
|
48
|
-
* 添加新模块和配置更新 ([bba4a67](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/bba4a67f1f5094dd89f6e51708aa50f8e1b00b65))
|
|
49
|
-
* 新增分转元方法 ([cc9d640](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/cc9d640d53497c4c7784606538d9a0bf49bd15cb))
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
|
+
|
|
5
|
+
### [1.0.15](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.14...v1.0.15) (2025-12-04)
|
|
6
|
+
|
|
7
|
+
### [1.0.14](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.13...v1.0.14) (2025-12-04)
|
|
8
|
+
|
|
9
|
+
### [1.0.13](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.12...v1.0.13) (2025-12-04)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### ✨ Features
|
|
13
|
+
|
|
14
|
+
* 更新-apiBuilder ([5f09e35](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/5f09e357cc8e306daacdd0f33599472cf2375b14))
|
|
15
|
+
* upateAPIbuilder ([482f2e1](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/482f2e100a49d167e4c5129cacd496fc85223567))
|
|
16
|
+
* upateAPIbuilder ([42a1f40](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/42a1f40a0606a3240726b4227155758950b4f722))
|
|
17
|
+
|
|
18
|
+
### [1.0.12](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.11...v1.0.12) (2025-11-17)
|
|
19
|
+
|
|
20
|
+
### [1.0.11](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.10...v1.0.11) (2025-11-11)
|
|
21
|
+
|
|
22
|
+
### [1.0.10](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.9...v1.0.10) (2025-11-11)
|
|
23
|
+
|
|
24
|
+
### [1.0.9](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/compare/v1.0.2...v1.0.9) (2025-11-11)
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### ✨ Features
|
|
28
|
+
|
|
29
|
+
* **build:** 新增依赖分类与分块优化功能(Chunk Optimizer) ([21c2d1a](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/21c2d1abb41c62b73bb2820a6132b3ffe027c086))
|
|
30
|
+
* **build:** 新增依赖分类与分块优化功能(Chunk Optimizer) ([1a3113d](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/1a3113dee7d8e7f67a7e48d9c6976514fbfd5297))
|
|
31
|
+
* 提交 saas平台项目需要的方法 ([e9bdefd](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/e9bdefd14d8d3006df3ff0e144321b2abf858444))
|
|
32
|
+
* 新增 `ApiBuilder` 工具类 ([62bc47e](https://cnb.jinbizhihui.com/jinbizhihui/frontend/jbwy-utils/commit/62bc47eb18f3f54495239ecd0cb40e0a78c3899a))
|
|
33
|
+
|
|
34
|
+
### [1.0.2](https://e.coding.net/jinbicloud/P8/jbwy-utils/compare/v1.0.1...v1.0.2) (2025-07-31)
|
|
35
|
+
|
|
36
|
+
### [1.0.1](https://e.coding.net/jinbicloud/P8/jbwy-utils/compare/v1.0.0...v1.0.1) (2025-07-25)
|
|
37
|
+
|
|
38
|
+
## 1.0.0 (2025-07-25)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### ✨ Features
|
|
42
|
+
|
|
43
|
+
* 1.调整日志中间件 接入的服务地址 ([5bf17c3](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/5bf17c3ada3ec825c7dc8ac1f1cae74e1ea54e76))
|
|
44
|
+
* 1.新增 nodejs 日志中间件工具库 2. 新增iam工具库 ([07a48c8](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/07a48c87cb061401aadca3026a7821ee6f0b8069))
|
|
45
|
+
* 更新版本和依赖项 ([1bcc026](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/1bcc026a8d2c8019180e0418bde7bef485ade566))
|
|
46
|
+
* 删除 wecom 模块及相关文档 ([6ef1215](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/6ef12157d1b7ff4b4bd1217a34fcca5af49bc3e2))
|
|
47
|
+
* 添加版本控制配置和更新依赖项 ([cfecef1](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/cfecef19fff25fb167ae251246ee268d9caaaa22))
|
|
48
|
+
* 添加新模块和配置更新 ([bba4a67](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/bba4a67f1f5094dd89f6e51708aa50f8e1b00b65))
|
|
49
|
+
* 新增分转元方法 ([cc9d640](https://e.coding.net/jinbicloud/P8/jbwy-utils/commit/cc9d640d53497c4c7784606538d9a0bf49bd15cb))
|
package/README.md
CHANGED
|
@@ -1,190 +1,190 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
# jbwy-utils 使用说明
|
|
6
|
-
|
|
7
|
-
这是一个实用工具库,包含了多个常用的功能模块。以下是各个模块的详细说明:
|
|
8
|
-
|
|
9
|
-
## 1. Common 模块 (common/index.ts)
|
|
10
|
-
通用函数集合,提供了一些基础工具方法:
|
|
11
|
-
|
|
12
|
-
### 1.1 判空相关
|
|
13
|
-
```typescript
|
|
14
|
-
import { isEmpty } from 'jbwy-utils/common'
|
|
15
|
-
|
|
16
|
-
isEmpty('') // 返回 true
|
|
17
|
-
isEmpty(null) // 返回 true
|
|
18
|
-
isEmpty(undefined) // 返回 true
|
|
19
|
-
isEmpty(12323) // 返回 false
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
### 1.2 环境判断
|
|
23
|
-
```typescript
|
|
24
|
-
import { getDeviceType, getEnvironment, getIsComWx } from 'jbwy-utils/common'
|
|
25
|
-
|
|
26
|
-
// 获取设备类型
|
|
27
|
-
const deviceInfo = getDeviceType()
|
|
28
|
-
// 返回: { isWxWork, isWeixin, isMobileScreen, isMobileAny }
|
|
29
|
-
|
|
30
|
-
// 获取运行环境
|
|
31
|
-
const env = getEnvironment()
|
|
32
|
-
// 返回: 'com-wx-mobile' | 'com-wx-pc' | 'wx-mobile' | 'wx-pc' | 'other'
|
|
33
|
-
|
|
34
|
-
// 判断是否企业微信环境
|
|
35
|
-
const isComWx = getIsComWx()
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### 1.3 URL参数处理
|
|
39
|
-
```typescript
|
|
40
|
-
import { getQueryString, getQueryVariable } from 'jbwy-utils/common'
|
|
41
|
-
|
|
42
|
-
// 获取URL参数
|
|
43
|
-
getQueryString(url, 'key')
|
|
44
|
-
getQueryVariable('key')
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
## 2. Number 模块 (number/index.ts)
|
|
48
|
-
数字处理相关函数:
|
|
49
|
-
|
|
50
|
-
```typescript
|
|
51
|
-
import { toThousands, formatFloat, ceil, floor } from 'jbwy-utils/number'
|
|
52
|
-
|
|
53
|
-
// 千分位格式化
|
|
54
|
-
toThousands(12345) // 返回 '12,345'
|
|
55
|
-
toThousands('12323.12') // 返回 '12,323.12'
|
|
56
|
-
|
|
57
|
-
// 格式化小数位
|
|
58
|
-
formatFloat('1.2345') // 返回 '1.23'
|
|
59
|
-
formatFloat('1.2345', 3) // 返回 '1.235'
|
|
60
|
-
|
|
61
|
-
// 向上取整
|
|
62
|
-
ceil('1.234', 2) // 返回 1.24
|
|
63
|
-
|
|
64
|
-
// 向下取整
|
|
65
|
-
floor('1.234', 2) // 返回 1.23
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
## 3. String 模块 (string/index.ts)
|
|
69
|
-
字符串处理相关函数:
|
|
70
|
-
|
|
71
|
-
```typescript
|
|
72
|
-
import { formatPhone, formatPhoneHide, formatBank } from 'jbwy-utils/string'
|
|
73
|
-
|
|
74
|
-
// 格式化手机号
|
|
75
|
-
formatPhone('18211572781') // 返回 '182 1157 2781'
|
|
76
|
-
formatPhone('18211572781', '-') // 返回 '182-1157-2781'
|
|
77
|
-
|
|
78
|
-
// 隐藏手机号中间四位
|
|
79
|
-
formatPhoneHide('18211572781') // 返回 '182****2781'
|
|
80
|
-
|
|
81
|
-
// 格式化银行卡号
|
|
82
|
-
formatBank('6282356862823568123') // 返回 '6282 3568 6282 3568 123'
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
## 4. Validate 模块 (validate/index.ts)
|
|
86
|
-
提供各种验证函数:
|
|
87
|
-
|
|
88
|
-
```typescript
|
|
89
|
-
import { isMobile, isEmail, isTelephone, isQQ } from 'jbwy-utils/validate'
|
|
90
|
-
|
|
91
|
-
// 验证手机号
|
|
92
|
-
isMobile('13800138000') // 返回 true/false
|
|
93
|
-
|
|
94
|
-
// 验证邮箱
|
|
95
|
-
isEmail('example@email.com') // 返回 true/false
|
|
96
|
-
|
|
97
|
-
// 验证固定电话
|
|
98
|
-
isTelephone('0755-88888888') // 返回 true/false
|
|
99
|
-
|
|
100
|
-
// 验证QQ号
|
|
101
|
-
isQQ('10000') // 返回 true/false
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
## 5. File 模块 (file/index.ts)
|
|
105
|
-
文件处理相关函数:
|
|
106
|
-
|
|
107
|
-
```typescript
|
|
108
|
-
import { calcFileSize, fileSizeFormat, compressImg } from 'jbwy-utils/file'
|
|
109
|
-
|
|
110
|
-
// 计算文件大小
|
|
111
|
-
calcFileSize(1024) // 返回 { size: 1, unit: 'KB' }
|
|
112
|
-
|
|
113
|
-
// 格式化文件大小
|
|
114
|
-
fileSizeFormat('1024', 'KB') // 返回 '1MB'
|
|
115
|
-
|
|
116
|
-
// 压缩图片
|
|
117
|
-
compressImg(file, scaleCallback, qualityCallback)
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
## 6. Object 模块 (object/index.ts)
|
|
121
|
-
对象处理相关函数:
|
|
122
|
-
|
|
123
|
-
```typescript
|
|
124
|
-
import { deepEqual, findNodePath } from 'jbwy-utils/object'
|
|
125
|
-
|
|
126
|
-
// 深度比较两个对象是否相等
|
|
127
|
-
deepEqual({a: 10}, {a: 10}) // 返回 true
|
|
128
|
-
deepEqual({a: 10}, {a: 10, b: 20}) // 返回 false
|
|
129
|
-
|
|
130
|
-
// 查找树结构节点路径
|
|
131
|
-
findNodePath(nodeValue, nodeKey, treeArray, childrenKey)
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
## 7. WeChat Work 模块 (wecom/wecom.ts)
|
|
135
|
-
企业微信相关功能:
|
|
136
|
-
|
|
137
|
-
```typescript
|
|
138
|
-
import { initWWConfig } from 'jbwy-utils/wecom'
|
|
139
|
-
|
|
140
|
-
// 初始化企业微信配置
|
|
141
|
-
initWWConfig()
|
|
142
|
-
```
|
|
143
|
-
## 8. middleware 模块 (middleware)
|
|
144
|
-
中间件相关功能:
|
|
145
|
-
### 8.1 requestLogger.middware.ts
|
|
146
|
-
|
|
147
|
-
日志服务 此插件支持使用了koa的nodejs项目
|
|
148
|
-
注意:(recordLogMiddleWare('project-plan-service'))需要传入项目名,日志文件会根据传入的项目名来 命名前缀
|
|
149
|
-
|
|
150
|
-
```typescript
|
|
151
|
-
// midway 项目接入方案 configuration.ts
|
|
152
|
-
import { recordLogMiddleWare } from 'jinbi-utils'
|
|
153
|
-
|
|
154
|
-
export class MainConfiguration {
|
|
155
|
-
@App('koa')
|
|
156
|
-
app: koa.Application;
|
|
157
|
-
|
|
158
|
-
async onReady() {
|
|
159
|
-
//
|
|
160
|
-
this.app.useMiddleware([recordLogMiddleWare('project-plan-service')]);
|
|
161
|
-
|
|
162
|
-
}
|
|
163
|
-
}
|
|
164
|
-
```
|
|
165
|
-
```typescript
|
|
166
|
-
// 只用了koa的nodejs项目接入方案 app.js
|
|
167
|
-
import { recordLogMiddleWare } from 'jinbi-utils'
|
|
168
|
-
|
|
169
|
-
const app = new Koa();
|
|
170
|
-
app.use(bodyParser());
|
|
171
|
-
app.use(router.routes()).use(router.allowedMethods()).use(recordLogMiddleWare('project-plan-service'));
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
## 安装和使用
|
|
175
|
-
|
|
176
|
-
1. 安装依赖:
|
|
177
|
-
```bash
|
|
178
|
-
npm install jbwy-utils
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
2. 引入使用:
|
|
182
|
-
```typescript
|
|
183
|
-
import { isEmpty } from 'jbwy-utils/common'
|
|
184
|
-
import { formatPhone } from 'jbwy-utils/string'
|
|
185
|
-
// ... 按需引入其他功能
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
注意:所有模块都支持按需引入,可以只引入需要使用的功能,减少打包体积。
|
|
189
|
-
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
# jbwy-utils 使用说明
|
|
6
|
+
|
|
7
|
+
这是一个实用工具库,包含了多个常用的功能模块。以下是各个模块的详细说明:
|
|
8
|
+
|
|
9
|
+
## 1. Common 模块 (common/index.ts)
|
|
10
|
+
通用函数集合,提供了一些基础工具方法:
|
|
11
|
+
|
|
12
|
+
### 1.1 判空相关
|
|
13
|
+
```typescript
|
|
14
|
+
import { isEmpty } from 'jbwy-utils/common'
|
|
15
|
+
|
|
16
|
+
isEmpty('') // 返回 true
|
|
17
|
+
isEmpty(null) // 返回 true
|
|
18
|
+
isEmpty(undefined) // 返回 true
|
|
19
|
+
isEmpty(12323) // 返回 false
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### 1.2 环境判断
|
|
23
|
+
```typescript
|
|
24
|
+
import { getDeviceType, getEnvironment, getIsComWx } from 'jbwy-utils/common'
|
|
25
|
+
|
|
26
|
+
// 获取设备类型
|
|
27
|
+
const deviceInfo = getDeviceType()
|
|
28
|
+
// 返回: { isWxWork, isWeixin, isMobileScreen, isMobileAny }
|
|
29
|
+
|
|
30
|
+
// 获取运行环境
|
|
31
|
+
const env = getEnvironment()
|
|
32
|
+
// 返回: 'com-wx-mobile' | 'com-wx-pc' | 'wx-mobile' | 'wx-pc' | 'other'
|
|
33
|
+
|
|
34
|
+
// 判断是否企业微信环境
|
|
35
|
+
const isComWx = getIsComWx()
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### 1.3 URL参数处理
|
|
39
|
+
```typescript
|
|
40
|
+
import { getQueryString, getQueryVariable } from 'jbwy-utils/common'
|
|
41
|
+
|
|
42
|
+
// 获取URL参数
|
|
43
|
+
getQueryString(url, 'key')
|
|
44
|
+
getQueryVariable('key')
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## 2. Number 模块 (number/index.ts)
|
|
48
|
+
数字处理相关函数:
|
|
49
|
+
|
|
50
|
+
```typescript
|
|
51
|
+
import { toThousands, formatFloat, ceil, floor } from 'jbwy-utils/number'
|
|
52
|
+
|
|
53
|
+
// 千分位格式化
|
|
54
|
+
toThousands(12345) // 返回 '12,345'
|
|
55
|
+
toThousands('12323.12') // 返回 '12,323.12'
|
|
56
|
+
|
|
57
|
+
// 格式化小数位
|
|
58
|
+
formatFloat('1.2345') // 返回 '1.23'
|
|
59
|
+
formatFloat('1.2345', 3) // 返回 '1.235'
|
|
60
|
+
|
|
61
|
+
// 向上取整
|
|
62
|
+
ceil('1.234', 2) // 返回 1.24
|
|
63
|
+
|
|
64
|
+
// 向下取整
|
|
65
|
+
floor('1.234', 2) // 返回 1.23
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## 3. String 模块 (string/index.ts)
|
|
69
|
+
字符串处理相关函数:
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
import { formatPhone, formatPhoneHide, formatBank } from 'jbwy-utils/string'
|
|
73
|
+
|
|
74
|
+
// 格式化手机号
|
|
75
|
+
formatPhone('18211572781') // 返回 '182 1157 2781'
|
|
76
|
+
formatPhone('18211572781', '-') // 返回 '182-1157-2781'
|
|
77
|
+
|
|
78
|
+
// 隐藏手机号中间四位
|
|
79
|
+
formatPhoneHide('18211572781') // 返回 '182****2781'
|
|
80
|
+
|
|
81
|
+
// 格式化银行卡号
|
|
82
|
+
formatBank('6282356862823568123') // 返回 '6282 3568 6282 3568 123'
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## 4. Validate 模块 (validate/index.ts)
|
|
86
|
+
提供各种验证函数:
|
|
87
|
+
|
|
88
|
+
```typescript
|
|
89
|
+
import { isMobile, isEmail, isTelephone, isQQ } from 'jbwy-utils/validate'
|
|
90
|
+
|
|
91
|
+
// 验证手机号
|
|
92
|
+
isMobile('13800138000') // 返回 true/false
|
|
93
|
+
|
|
94
|
+
// 验证邮箱
|
|
95
|
+
isEmail('example@email.com') // 返回 true/false
|
|
96
|
+
|
|
97
|
+
// 验证固定电话
|
|
98
|
+
isTelephone('0755-88888888') // 返回 true/false
|
|
99
|
+
|
|
100
|
+
// 验证QQ号
|
|
101
|
+
isQQ('10000') // 返回 true/false
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## 5. File 模块 (file/index.ts)
|
|
105
|
+
文件处理相关函数:
|
|
106
|
+
|
|
107
|
+
```typescript
|
|
108
|
+
import { calcFileSize, fileSizeFormat, compressImg } from 'jbwy-utils/file'
|
|
109
|
+
|
|
110
|
+
// 计算文件大小
|
|
111
|
+
calcFileSize(1024) // 返回 { size: 1, unit: 'KB' }
|
|
112
|
+
|
|
113
|
+
// 格式化文件大小
|
|
114
|
+
fileSizeFormat('1024', 'KB') // 返回 '1MB'
|
|
115
|
+
|
|
116
|
+
// 压缩图片
|
|
117
|
+
compressImg(file, scaleCallback, qualityCallback)
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## 6. Object 模块 (object/index.ts)
|
|
121
|
+
对象处理相关函数:
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
import { deepEqual, findNodePath } from 'jbwy-utils/object'
|
|
125
|
+
|
|
126
|
+
// 深度比较两个对象是否相等
|
|
127
|
+
deepEqual({a: 10}, {a: 10}) // 返回 true
|
|
128
|
+
deepEqual({a: 10}, {a: 10, b: 20}) // 返回 false
|
|
129
|
+
|
|
130
|
+
// 查找树结构节点路径
|
|
131
|
+
findNodePath(nodeValue, nodeKey, treeArray, childrenKey)
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## 7. WeChat Work 模块 (wecom/wecom.ts)
|
|
135
|
+
企业微信相关功能:
|
|
136
|
+
|
|
137
|
+
```typescript
|
|
138
|
+
import { initWWConfig } from 'jbwy-utils/wecom'
|
|
139
|
+
|
|
140
|
+
// 初始化企业微信配置
|
|
141
|
+
initWWConfig()
|
|
142
|
+
```
|
|
143
|
+
## 8. middleware 模块 (middleware)
|
|
144
|
+
中间件相关功能:
|
|
145
|
+
### 8.1 requestLogger.middware.ts
|
|
146
|
+
|
|
147
|
+
日志服务 此插件支持使用了koa的nodejs项目
|
|
148
|
+
注意:(recordLogMiddleWare('project-plan-service'))需要传入项目名,日志文件会根据传入的项目名来 命名前缀
|
|
149
|
+
|
|
150
|
+
```typescript
|
|
151
|
+
// midway 项目接入方案 configuration.ts
|
|
152
|
+
import { recordLogMiddleWare } from 'jinbi-utils'
|
|
153
|
+
|
|
154
|
+
export class MainConfiguration {
|
|
155
|
+
@App('koa')
|
|
156
|
+
app: koa.Application;
|
|
157
|
+
|
|
158
|
+
async onReady() {
|
|
159
|
+
//
|
|
160
|
+
this.app.useMiddleware([recordLogMiddleWare('project-plan-service')]);
|
|
161
|
+
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
```
|
|
165
|
+
```typescript
|
|
166
|
+
// 只用了koa的nodejs项目接入方案 app.js
|
|
167
|
+
import { recordLogMiddleWare } from 'jinbi-utils'
|
|
168
|
+
|
|
169
|
+
const app = new Koa();
|
|
170
|
+
app.use(bodyParser());
|
|
171
|
+
app.use(router.routes()).use(router.allowedMethods()).use(recordLogMiddleWare('project-plan-service'));
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## 安装和使用
|
|
175
|
+
|
|
176
|
+
1. 安装依赖:
|
|
177
|
+
```bash
|
|
178
|
+
npm install jbwy-utils
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
2. 引入使用:
|
|
182
|
+
```typescript
|
|
183
|
+
import { isEmpty } from 'jbwy-utils/common'
|
|
184
|
+
import { formatPhone } from 'jbwy-utils/string'
|
|
185
|
+
// ... 按需引入其他功能
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
注意:所有模块都支持按需引入,可以只引入需要使用的功能,减少打包体积。
|
|
189
|
+
|
|
190
190
|
|
package/dist/chunk-optimizer.cjs
CHANGED
|
@@ -700,5 +700,4 @@ function createChunkOptimizer(options) {
|
|
|
700
700
|
|
|
701
701
|
exports.ChunkOptimizer = ChunkOptimizer;
|
|
702
702
|
exports.createChunkOptimizer = createChunkOptimizer;
|
|
703
|
-
exports
|
|
704
|
-
//# sourceMappingURL=chunk-optimizer.cjs.map
|
|
703
|
+
exports["default"] = createChunkOptimizer;
|