1.5.2 • Published 2 years ago
uni-shared-utils v1.5.2
uni-shared-utils
Github: https://github.com/hlhang-dev/uni-shared-utils
API
TokenManagement (该token存入后会成为HttpService默认的token)
| methods | type | remark |
|---|---|---|
| saveAccountToken | void | 保存token |
| getAccountToken | string || null | 获取token |
| removeAccountToken | void | 移除token |
LoginManagement
| methods | type | remark |
|---|---|---|
| isAccountLogin | boolean | 账户是否登录 |
| isAccountLoginBeOverdue | boolean | 账户是否登录但是过期了 |
| getWxCode | Promise | 获取微信code |
| checkWxLoginSession | Promise | 检查登录状态是否过期 |
ShowNoticeManagement
| methods | type | remark |
|---|---|---|
| showNormalNotice | void | 显示正常提示 |
| showSuccessNotice | void | 显示成功提示 |
| showErrorNotice | void | 显示错误提示 |
method的params
| params | type | remark | 选填 |
|---|---|---|---|
| title | string | 提示内容 | 否 |
| duration | number | 持续时间（默认2000ms） | 是 |
| isMask | boolean | 是否遮罩(默认false) | 是 |
LoadingManagement
| methods | type | remark |
|---|---|---|
| show | void | 显示Loading |
| hide | void | 隐藏Loading |
UniAppManagement 优化了UniAppApi的缺陷 例如打开文件还需要先调用dowloadApi 在UniAppManagement中可直接传入url 可以点开源码自行查看
HttpInit(全局网络请求初始化)
| methods | type | remark |
|---|---|---|
| init | void | 初始化方法 |
init参数
| params | type | remark | 选填 |
|---|---|---|---|
| loginPage | string | 当无权限时跳转的页面 | |
| timeout | number | 超时时间 | 是 |
| successCode | number | 成功的code（会影响到返回的success值） | 是 |
| successParamStr | string | 成功的code的字段名 | 是 |
| serverMessageParamStr | string | 服务器message的字段名 | 是 |
| header | object | 全局requestHeader（若不想使用自带的token处理器可以在这里覆盖header） | 是 |
| isShowLoading | boolean | 是否显示Loading(默认true) | 是 |
示例
HttpService 发起网络请求
| methods | type | remark |
|---|---|---|
| doRequest | Promise | 发起http请求 |
doRequest参数
| params | type | remark | 选填 |
|---|---|---|---|
| url | string | 请求url | 否 |
| method | string | 方式 | 否 |
| data | object | 数据 | 是 |
| headers | object | 该请求携带header（局部的） | 是 |
| showLoading | object | 是否显示Loading(默认true) | 是 |
示例
PageInit 初始化页面
| methods | type | remark |
|---|---|---|
| init | void | 初始化 |
init 参数
| param | type | remark |
|---|---|---|
| tabBarPath | string[] | TabBar页面路径 |
UniMapper
| methods | type | remark |
|---|---|---|
| uploadFile | Promise | 上传单个文件 |
| uploadFiles | Promise | 上传多个文件 |
uploadFile params
| params | type | remark | 选填 |
|---|---|---|---|
| uploadFileItem | UploadItemDTO | 待上传文件 | 否 |
| url | string | 文件上传后端url | 否 |
| token | string | 文件上传token(默认使用tokenManagement中存储的token) | 是 |
| key | string | 文件上传key（默认”file“） | 是 |
| fileType | string | 文件类型（默认 'image' ） | 'video' |
uploadFiles params
| params | type | remark | 选填 |
|---|---|---|---|
| uploadFileItem | Array | 待上传文件列表 | 否 |
| url | string | 文件上传后端url | 否 |
| token | string | 文件上传token(默认使用tokenManagement中存储的token) | 是 |
| key | string | 文件上传key（默认”file“） | 是 |
| fileType | string | 文件类型（默认 'image' ） | 是 |
Beans
UploadItemDTO
| params | type | remark |
|---|---|---|
| id | string | 随机id |
| localPath | string | 本地路径 |
| networkPath | string | 网路路径 |
| serverData | any | 文件上传完会把服务器数据吐到这个字段里 |
| isUpload | boolean | 是否上传 |
ApiUnifiedVO
| params | type | remark |
|---|---|---|
| data | BaseServiceVO | 服务器数据 |
| header | HeaderVO | responseHeader |
| statusCode | HttpStatusCode | 服务器状态码 |
| errMsg | string | errMsg |
BaseServiceVO
| params | type | remark |
|---|---|---|
| success | boolean | 是否成功 |
| code | string | 服务器code |
| msg | string | 服务器msg |
| result | string | 服务器data |
HeaderVO
| params | type | remark |
|---|---|---|
| contentType | string | 数据类型 |
| date | string | 时间 |
| server | string | server name |
1.5.2
2 years ago
1.5.1
2 years ago
1.5.0
2 years ago
1.4.6
3 years ago
1.3.7
3 years ago
1.2.8
3 years ago
1.4.5
3 years ago
1.3.6
3 years ago
1.2.7
3 years ago
1.4.4
3 years ago
1.3.5
3 years ago
1.2.6
3 years ago
1.4.3
3 years ago
1.3.4
3 years ago
1.2.5
3 years ago
1.4.2
3 years ago
1.3.3
3 years ago
1.2.4
3 years ago
1.4.1
3 years ago
1.3.2
3 years ago
1.2.3
3 years ago
1.4.0
3 years ago
1.3.1
3 years ago
1.2.2
3 years ago
1.3.0
3 years ago
1.4.9
2 years ago
1.4.8
2 years ago
1.3.9
3 years ago
1.4.7
2 years ago
1.3.8
3 years ago
1.2.9
3 years ago
1.2.1
3 years ago
1.2.0
3 years ago
1.1.9
3 years ago
1.1.8
3 years ago
1.1.7
3 years ago
1.1.6
3 years ago
1.1.5
3 years ago
1.1.4
3 years ago
1.1.3
3 years ago
1.1.2
3 years ago
1.1.1
3 years ago
2.0.0
3 years ago
1.1.0
3 years ago
1.0.1
3 years ago
1.0.0
3 years ago