wgt-node-utils 0.0.29 → 0.0.32
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/README.md +248 -89
- package/dist/bundle.js +1 -1
- package/package.json +1 -1
- package/src/index.js +14 -4
package/README.md
CHANGED
|
@@ -1,92 +1,251 @@
|
|
|
1
1
|
# wgt-node-utils
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
3
|
+
# 发布流程
|
|
4
|
+
**1、设置npm发布仓库地址为Nexus的地址**
|
|
5
|
+
```sh
|
|
6
|
+
npm set http://172.30.10.160:8081/nexus/repository/wgt/
|
|
7
|
+
```
|
|
8
|
+
**2、 发布包整体**
|
|
9
|
+
```sh
|
|
10
|
+
npm publish --registry http://172.30.10.160:8081/nexus/repository/wgt/
|
|
11
|
+
```
|
|
12
|
+
# wgt node端 公共函数库 使用方法
|
|
13
|
+
> 项目安装脚本
|
|
14
|
+
```sh
|
|
15
|
+
npm install wgt-node-utils --registry http://172.30.10.160:8081/nexus/repository/npm-group
|
|
16
|
+
```
|
|
17
|
+
## 工具库使用
|
|
18
|
+
```javascript
|
|
19
|
+
const wgtNodeUtils = require('wgt-node-utils');
|
|
20
|
+
wgtNodeUtils.getSiteByHostname(siteIdPath, req.hostname, DEFAULT_SITE_ID)
|
|
16
21
|
```
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
22
|
+
### 工具函数说明
|
|
23
|
+
#### getSystem 获取系统信息
|
|
24
|
+
#### 使用
|
|
25
|
+
```javascript
|
|
26
|
+
wgtNodeUtils.getSystem(userAgent)
|
|
27
|
+
```
|
|
28
|
+
##### 参数说明:
|
|
29
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
30
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
31
|
+
| userAgent | string | 设备的Ua信息 | 是 | -- |
|
|
32
|
+
|
|
33
|
+
#### getCloudFrontDevice 获取系统信息
|
|
34
|
+
#### 使用
|
|
35
|
+
```javascript
|
|
36
|
+
wgtNodeUtils.getCloudFrontDevice(headers)
|
|
37
|
+
```
|
|
38
|
+
##### 参数说明:
|
|
39
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
40
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
41
|
+
| headers | object | CDN 返回的req.headers 对象 | 是 | -- |
|
|
42
|
+
|
|
43
|
+
#### getCloudFrontSystem // 获取cloud front传回的设备信息
|
|
44
|
+
#### 使用
|
|
45
|
+
```javascript
|
|
46
|
+
wgtNodeUtils.getCloudFrontSystem(device)
|
|
47
|
+
```
|
|
48
|
+
##### 参数说明:
|
|
49
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
50
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
51
|
+
| device | string | 回传设备信息 | 是 | -- |
|
|
52
|
+
|
|
53
|
+
#### addCommonHeadersInfo // 通用头信息添加
|
|
54
|
+
#### 使用
|
|
55
|
+
```javascript
|
|
56
|
+
wgtNodeUtils.addCommonHeadersInfo(res)
|
|
57
|
+
```
|
|
58
|
+
##### 参数说明:
|
|
59
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
60
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
61
|
+
| res | object | node端 响应 header 对象 | 是 | -- |
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
#### getSiteByHostname // 获取siteId 通过hostname
|
|
65
|
+
#### 使用方法
|
|
66
|
+
```javascript
|
|
67
|
+
await wgtNodeUtils.getSiteByHostname(url, hostname, defaultSiteId)
|
|
68
|
+
```
|
|
69
|
+
##### 参数说明:
|
|
70
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
71
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
72
|
+
| url | string | 获取siteID接口地址 | 是 | -- |
|
|
73
|
+
| hostname | string | 网站解析域名 | 是 | -- |
|
|
74
|
+
| defaultSiteId | string | 网站默认siteID | 是 | -- |
|
|
75
|
+
|
|
76
|
+
#### readF2eFiles // node启动时将静态资源读取到内存中
|
|
77
|
+
#### 使用方法
|
|
78
|
+
```javascript
|
|
79
|
+
await wgtNodeUtils.readF2eFiles(buildName, version, dirname, useReactRouterDom)
|
|
80
|
+
```
|
|
81
|
+
##### 参数说明:
|
|
82
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
83
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
84
|
+
| buildName | string | 项目打包名称 | 是 | -- |
|
|
85
|
+
| version | string | 项目版本号 | 是 | -- |
|
|
86
|
+
| dirname | string | 项目绝对地址 | 是 | -- |
|
|
87
|
+
| useReactRouterDom | boolean | 是否需要今天文件ReactRouterDom | 是 | false |
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
#### getMainDomainByHostname // 获取主域名
|
|
91
|
+
#### 使用
|
|
92
|
+
```javascript
|
|
93
|
+
wgtNodeUtils.getMainDomainByHostname(hostname)
|
|
94
|
+
```
|
|
95
|
+
##### 参数说明:
|
|
96
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
97
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
98
|
+
| hostname | string | 网站地址 | 是 | -- |
|
|
99
|
+
|
|
100
|
+
#### appendLog // node启动时将静态资源读取到内存中
|
|
101
|
+
#### 使用方法
|
|
102
|
+
```javascript
|
|
103
|
+
await wgtNodeUtils.appendLog(message, ENV, components, err)
|
|
104
|
+
```
|
|
105
|
+
##### 参数说明:
|
|
106
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
107
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
108
|
+
| message | string | 错误信息 | 是 | -- |
|
|
109
|
+
| err | string || object | 错误类型 | 否 | -- |
|
|
110
|
+
| ENV | string | 环境变量 | 是 | -- |
|
|
111
|
+
| components | string | 项目名称 | 是 | -- |
|
|
112
|
+
|
|
113
|
+
#### isEmptyObj // 验证是否空对象
|
|
114
|
+
#### 使用
|
|
115
|
+
```javascript
|
|
116
|
+
wgtNodeUtils.isEmptyObj(object)
|
|
117
|
+
```
|
|
118
|
+
##### 参数说明:
|
|
119
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
120
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
121
|
+
| object | object | 验证对象 | 是 | -- |
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
#### clearGameCardListData // 用于渲染游戏卡列表，清理无用字段
|
|
125
|
+
#### 使用
|
|
126
|
+
```javascript
|
|
127
|
+
wgtNodeUtils.clearGameCardListData(list)
|
|
128
|
+
```
|
|
129
|
+
##### 参数说明:
|
|
130
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
131
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
132
|
+
| list | array | 所需要清理的list item返回格式 | 是 | -- |
|
|
133
|
+
##### 返回格式
|
|
134
|
+
```javascript
|
|
135
|
+
return {
|
|
136
|
+
id: item.game_id,
|
|
137
|
+
icon: item.base_icon,
|
|
138
|
+
path: item.game_path,
|
|
139
|
+
name: item.game_name,
|
|
140
|
+
icon_video: item.icon_video,
|
|
141
|
+
new: item.new ? true : undefined // 将false转换为undefined， 用于节省ssr生成的文本长度
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
#### clearGameData // 用于渲染游戏详情的数据，清理无用字段
|
|
146
|
+
#### 使用
|
|
147
|
+
```javascript
|
|
148
|
+
wgtNodeUtils.clearGameData(list)
|
|
149
|
+
```
|
|
150
|
+
##### 参数说明:
|
|
151
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
152
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
153
|
+
| list | array | 所需要清理的list | 是 | -- |
|
|
154
|
+
##### 返回格式
|
|
155
|
+
```javascript
|
|
156
|
+
return {
|
|
157
|
+
id: item.id,
|
|
158
|
+
path: item.path,
|
|
159
|
+
icon: item.base_icon,
|
|
160
|
+
name: item.name
|
|
161
|
+
};
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
#### clearCategoryListData // 用于渲染类型卡片列表，清理无用字段
|
|
165
|
+
#### 使用
|
|
166
|
+
```javascript
|
|
167
|
+
wgtNodeUtils.clearCategoryListData(list)
|
|
168
|
+
```
|
|
169
|
+
##### 参数说明:
|
|
170
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
171
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
172
|
+
| list | array | 所需要清理的list | 是 | -- |
|
|
173
|
+
##### 返回格式
|
|
174
|
+
```javascript
|
|
175
|
+
return {
|
|
176
|
+
id: item.id,
|
|
177
|
+
path: item.path,
|
|
178
|
+
icon: item.base_icon,
|
|
179
|
+
name: item.name
|
|
180
|
+
};
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
#### clearWalkThroughVideoListData // 用于渲染演练视频卡片的数据，清理无用字段
|
|
184
|
+
#### 使用
|
|
185
|
+
```javascript
|
|
186
|
+
wgtNodeUtils.clearWalkThroughVideoListData(list)
|
|
187
|
+
```
|
|
188
|
+
##### 参数说明:
|
|
189
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
190
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
191
|
+
| list | array | 所需要清理的list | 是 | -- |
|
|
192
|
+
##### 返回格式
|
|
193
|
+
```javascript
|
|
194
|
+
return {
|
|
195
|
+
game_name: item.game_name,
|
|
196
|
+
game_path: item.game_path,
|
|
197
|
+
thumbnail: item.thumbnail,
|
|
198
|
+
video_id: item.video_id,
|
|
199
|
+
duration: item.duration
|
|
200
|
+
};
|
|
201
|
+
```
|
|
202
|
+
#### getLanguageList // 获取网站语言列表
|
|
203
|
+
#### 使用
|
|
204
|
+
```javascript
|
|
205
|
+
wgtNodeUtils.getLanguageList(url)
|
|
206
|
+
```
|
|
207
|
+
##### 参数说明:
|
|
208
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
209
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
210
|
+
| hostname | string | 网站语言请求地址 | 是 | -- |
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
#### checkDomainAvailability // 监测域名是否可用 以状态返回200为准 返回 boolean
|
|
214
|
+
#### 使用
|
|
215
|
+
```javascript
|
|
216
|
+
wgtNodeUtils.checkDomainAvailability(url)
|
|
217
|
+
```
|
|
218
|
+
##### 参数说明:
|
|
219
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
220
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
221
|
+
| url | string | 需要检查域名地址 | 是 | -- |
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
#### ReplaceGameResources // 游戏详情页面， 游戏资源链接替换 返回字符串
|
|
225
|
+
#### 使用
|
|
226
|
+
```javascript
|
|
227
|
+
await wgtNodeUtils.ReplaceGameResources(link, hostName, ENV)
|
|
228
|
+
```
|
|
229
|
+
##### 参数说明:
|
|
230
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
231
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
232
|
+
| link | string | 需要检查域名地址 | 是 | -- |
|
|
233
|
+
| hostName | string | 需要检查域名地址 | 是 | -- |
|
|
234
|
+
| ENV | string | 需要检查域名地址 | 是 | -- |
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
#### getModelF2eFiles // 获取前端静态资源列表
|
|
238
|
+
#### 使用
|
|
239
|
+
```javascript
|
|
240
|
+
await wgtNodeUtils.(pageName, isMobile, useReactRouterDom = false)
|
|
241
|
+
```
|
|
242
|
+
##### 参数说明:
|
|
243
|
+
|参数 | 类型 | 说明 | 是否必传 | 默认值 |
|
|
244
|
+
|---------|--------------|-----------------------------------------------------------------------------|------|-----|
|
|
245
|
+
| pageName | string | 静态页面文件名称 | 是 | -- |
|
|
246
|
+
| isMobile | boolean | 是否为手机设备 | 是 | -- |
|
|
247
|
+
| useReactRouterDom | boolean | 是否需要ReactRouterDom | 是 | -- |
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|