tmui-cli 2.0.3 → 2.0.5

package/data/uniappx/api/unicloud/function.md

@@ -0,0 +1,83 @@
+## callFunction(options) @callfunction
+
+> 4.13版本起安卓端使用`UniCloudCallFunctionResult`必须传入泛型，比如`UniCloudCallFunctionResult<UTSJSONObject>`，其中泛型类型为其result属性的类型
+
+请求云函数
+
+### callFunction 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | **UniCloudCallFunctionOptions** | 是 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| name | string (string.CloudFunctionString) | 是 |   | 云函数名 |
+| data | UTSJSONObject | 否 |   | 云函数参数 |
+| secretType | string | 否 | Web x / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS x（部分支持，见上） | 加密类型，指定加密请求、响应还是都加密 |
+@@| 合法值 | 兼容性 |
+@@| :- |  :-: |
+@@| 'request' | Web x / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS x（部分支持，见上） |
+@@| response |   |
+@@| both |   |
+@@| none |   |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| Promise\<**UniCloudCallFunctionResult**> |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| result | [UniCloudCallFunctionResult](#unicloudcallfunctionresult-values) | 是 | 云函数返回结果 |
+| requestId | string | 否 | 云函数请求id |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudFunction.callFunction)
+
+### 调用云函数时传入泛型
+
+> 4.13版本起支持，仅安卓端会构造对应的泛型的实例，web端和iOS端泛型仅作为类型使用。
+
+用法：`uniCloud.callFunction<泛型类型>({name: 'xxx', data: {}} as UniCloudCallFunctionOptions)`
+
+在不传泛型时callFunction返回的类型为`Promise<UniCloudCallFunctionResult<UTSJSONObject>>`，传入泛型后callFunction返回的类型为`Promise<UniCloudCallFunctionResult<泛型类型>>`
+
+**代码示例**
+
+```ts
+// 云函数fn代码
+'use strict';
+exports.main = async (event, context) => {
+  return {
+    errCode: 0,
+    errMsg: '',
+    detail: 'call function detail'
+  };
+};
+```
+
+```ts
+// 客户端代码
+type CallFunctionResult = {
+  errCode : number,
+  errMsg : string,
+  detail : string
+}
+uniCloud.callFunction<CallFunctionResult>(
+  {
+    name: 'fn',
+    data: { a: 1 } as UTSJSONObject,
+  } as UniCloudCallFunctionOptions
+).then(function (res) {
+  const result = res.result // result的类型为CallFunctionResult
+  const detail = result.detail // 可直接使用.detail访问
+  console.log(detail)
+}).catch(function (err : any | null) {
+  console.error(err)
+})
+```

package/data/uniappx/api/unicloud/object.md

@@ -0,0 +1,138 @@
+## importObject(objectName, options?) @importobject
+
+引用云对象
+
+### importObject 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| objectName | string (string.CloudObjectString) | 是 |
+| options | **UniCloudImportObjectOptions** | 否 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| customUI | boolean | 否 |   | 是否移除自动展示的ui |
+| loadingOptions | **UniCloudImportObjectLoadingOptions** | 否 |   | loading界面配置 |
+@@| 名称 | 类型 | 必备 | 描述 |
+@@| :- | :- | :- | :- |
+@@| title | string | 否 | 加载框标题 |
+@@| mask | boolean | 否 | 加载框是否显示mask |
+| errorOptions | **UniCloudImportObjectErrorOptions** | 否 |   | 错误提示配置 |
+@@| 名称 | 类型 | 必备 | 描述 |
+@@| :- | :- | :- | :- |
+@@| type | string | 否 | 错误提示类型，可以是modal或者toast |
+@@| retry | boolean | 否 | 是否显示重试按钮 |
+| secretMethods | Record\<K, T> | 否 | Web x / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS x（部分支持，见上） | 指定方法的加密类型 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| [UniCloudCloudObjectCaller](#unicloudcloudobjectcaller-values) |
+| 名称 | 类型 | 必备 |
+| :- | :- | :- |
+| _obj | [InternalUniCloudCloudObject](#internalunicloudcloudobject-values) | 是 |
+##### InternalUniCloudCloudObject 的方法 @internalunicloudcloudobject-values 
+
+##### callMethod\<T = UTSJSONObject>(methodName: string, args: Array\<any>): Promise\<T>; @callmethod
+callMethod
+
+##### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| methodName | string | 是 |
+| args | Array&lt;any&gt; | 是 | 
+
+###### 返回值 
+
+| 类型 |
+| :- |
+| Promise\<T> |
+ 
+
+#### UniCloudCloudObjectCaller 的方法 @unicloudcloudobjectcaller-values 
+
+#### _getArgs: protected _getArgs(...args: Array\<any>): Array\<any \| null>; @_getargs
+_getArgs
+
+##### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| args | Array&lt;any&gt; | 否 | 
+
+##### 返回值 
+
+| 类型 |
+| :- |
+| Array&lt;any&gt; |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudObject.importObject)
+
+### uni-app x内使用云对象的特殊说明@strictly-typed-object
+
+由于强类型语言的限制，uni-app-x在编译时需要读取本地云对象导出的方法列表生成客户端对象。
+- 请确保调用的云对象在本地包含导出的方法。
+- 请确保本地工程的云对象的方法是正确的。
+- 如由于云函数加密等因素导致`index.obj.js`无法被正确解析，请在云对象目录创建`index.obj.d.ts`声明云对象内包含的方法。`index.obj.d.ts`示例代码如下：
+
+```ts
+// index.obj.d.ts
+type AnyFunction = (...args: any[]) => any;
+
+declare const add: AnyFunction
+declare const update: AnyFunction
+declare const deleteRecord: AnyFunction
+
+export { // 上面的写法可以自己调整，仅需保证export内包含所有方法即可
+  add,
+  update
+  deleteRecord as remove
+}
+```
+
+### 调用云对象时传入泛型
+
+> 4.13版本起支持，仅安卓端会构造对应的泛型的实例，web端和iOS端泛型仅作为类型使用。
+
+用法：`obj.add<泛型类型>()`
+
+在不传泛型时云对象方法返回的类型为`Promise<UTSJSONObject>`，传入泛型后callFunction返回的类型为`Promise<泛型类型>`
+
+**代码示例**
+
+```ts
+// 云对象todo代码
+'use strict';
+module.exports = {
+  async add(title, content) {
+    return {
+      errCode: 0,
+      errMsg: '',
+      detail: `Todo added, title: ${title}, content: ${content}`
+    }
+  },
+}
+```
+
+```ts
+// 客户端代码
+const todo = uniCloud.importObject('todo')
+type CallObjectResult = {
+  errCode : number
+  errMsg : string
+  detail : string
+}
+todo.add<CallObjectResult>('todo title', 'todo content').then((res) => {
+  const detail = res.detail // res类型为CallObjectResult，可直接通过.detail访问其中detail属性
+  console.log(detail)
+}).catch((err : any | null) => {
+  console.error(err)
+})
+```

package/data/uniappx/api/unicloud/sse-channel.md

@@ -0,0 +1,92 @@
+# 云函数请求中的中间状态通知通道
+
+> 新增于HBuilderX 4.71
+
+云函数在执行长时间任务时客户端无法获取云端任务执行状态，用户无法确定云函数是否还在正常执行，有些用户可能直接放弃等待刷新页面重新执行，从而导致浪费了更多的云函数资源。因此在此场景下需要一个云函数通知客户端发送执行状态或中间结果的通道。
+
+在常规web开发时通过云端向响应流多次写入数据的方式来实现，但是云函数不支持这种用法，因此我们基于uni-push实现了这个替代方案。
+
+使用此功能前需要先开通uni-push 2.0，参考文档：[uni-push 2.0](https://uniapp.dcloud.net.cn/unipush-v2.html)。uni-app-x项目使用SSEChannel需要自行配置uni-push模块到manifest.json内，且开发期间需要打包自定义基座进行测试。
+
+但是，在uni-app x中使用AI大模型流式返回数据时，持续保持云函数活跃会产生更多的费用。为此 uni-ai x，支持了云端返回临时token，由客户端直连LLM。除了节省费用，uni-ai x还提供了完整的客户端开源代码。[详见](https://ext.dcloud.net.cn/plugin?name=uni-ai-x)
+
+## 客户端api
+
+### SSEChannel(options) @ssechannel
+
+### 客户端代码示例
+
+```javascript
+async function receiveMessage() {
+  const sseChannel = new uniCloud.SSEChannel()
+  sseChannel.on('message', (message?: any | null) => {
+    console.log('message: ' + (message as string)) // message可能是任意类型，需要自行as为实际类型再使用
+  })
+  sseChannel.on('end', (message?: any | null) => {
+    console.log('end: ' + message) // message可能是任意类型，需要自行as为实际类型再使用。此处在云端end事件返回了null。目标语言是js时可能会返回undefined
+  })
+  sseChannel.on('open', () => {
+    console.log('sseChannel open')
+  })
+  sseChannel.on('close', () => {
+    console.log('sseChannel close')
+  })
+  sseChannel.on('error', (error: UniCloudError) => {
+    console.log('sseChannel error: ' + error.message)
+  })
+  await sseChannel.open() // 必须await通道开启，才可以将sseChannel传入云函数
+  const res = await uniCloud.callFunction({
+    name: 'sse',
+    data: {
+      sseChannel
+    }
+  })
+  console.log(res)
+}
+```
+
+## 云函数api
+
+### 反序列化消息通道@cloud-deserialize-channel
+
+将客户端传入的sseChannel反序列化为SSEChannel对象，用于发送消息。
+
+```javascript
+uniCloud.deserializeSSEChannel(sseChannelObj: string): SSEChannel
+```
+
+### sseChannel.write
+
+向客户端发送消息。
+
+```javascript
+sseChannel.write(message: any): Promise<void>
+```
+
+### sseChannel.end
+
+结束消息通道。
+
+```javascript
+sseChannel.end(message: any): Promise<void>
+```
+
+### 云函数代码示例
+
+```javascript
+'use strict';
+exports.main = async (event, context) => {
+  const sseChannelObj = event.sseChannel
+  const sseChannel = uniCloud.deserializeSSEChannel(sseChannelObj)
+  return new Promise(async (resolve, reject) => {
+    await sseChannel.write('message1')
+    await sseChannel.write('message2')
+    setTimeout(async () => {
+      await sseChannel.end()
+      resolve({
+        errCode: 0
+      })
+    }, 300)
+  })
+};
+```

package/data/uniappx/api/unicloud/storage.md

@@ -0,0 +1,204 @@
+## uploadFile(options) @uploadfile
+
+上传文件到云存储
+
+### uploadFile 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | [UniCloudUploadFileOptions](#uniclouduploadfileoptions-values) | 是 |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| filePath | string | 是 | 文件路径 |
+| cloudPath | string | 是 | 云端路径 |
+| cloudPathAsRealPath | boolean | 否 | 是否以云端路径是否为真实路径保存上传的文件 | 
+
+### UniCloudUploadFileOptions 的方法 @uniclouduploadfileoptions-values 
+
+### onUploadProgress: (options: UniCloudUploadProgress) => any @onuploadprogress
+onUploadProgress
+上传进度回调
+
+#### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| options | **UniCloudUploadProgress** | 是 | 上传进度回调参数 |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| loaded | number | 是 | 已上传大小 |
+| total | number | 是 | 总大小 | 
+
+#### 返回值 
+
+| 类型 |
+| :- |
+| any |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| Promise\<**UniCloudUploadFileResult**> |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| filePath | string | 是 | 文件路径 |
+| fileID | string | 是 | 文件id |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.uploadFile)
+
+## chooseAndUploadFile(options) @chooseanduploadfile
+
+选择并上传文件
+
+### chooseAndUploadFile 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | [UniCloudChooseAndUploadFileOptions](#unicloudchooseanduploadfileoptions-values) | 是 |
+| 名称 | 类型 | 必备 |
+| :- | :- | :- |
+| sourceType | Array&lt;string&gt; | 否 |
+@@| 合法值 |
+@@| :- |
+@@| album |
+@@| camera |
+| count | number | 否 |
+| sizeType | Array&lt;string&gt; | 否 |
+@@| 合法值 |
+@@| :- |
+@@| original |
+@@| compressed |
+| extension | Array&lt;string&gt; | 否 |
+| compressed | boolean | 否 |
+| maxDuration | number | 否 |
+| camera | string | 否 |
+@@| 合法值 |
+@@| :- |
+@@| front |
+@@| back |
+| crop | ChooseImageCropOptions | 否 |
+| type | string | 是 |
+@@| 合法值 |
+@@| :- |
+@@| image |
+@@| video |
+@@| all | 
+
+### UniCloudChooseAndUploadFileOptions 的方法 @unicloudchooseanduploadfileoptions-values 
+
+### onChooseFile: (arg: UniCloudChooseAndUploadFileResult) => void \| null @onchoosefile
+onChooseFile
+
+#### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| arg | **UniCloudChooseAndUploadFileResult** | 是 |
+| 名称 | 类型 | 必备 |
+| :- | :- | :- |
+| tempFiles | Array&lt;**UniCloudChooseAndUploadFileItem**&gt; | 是 |
+@@| 名称 | 类型 | 必备 |
+@@| :- | :- | :- |
+@@| name | string | 是 |
+@@| path | string | 是 |
+@@| cloudPath | string | 是 |
+@@| cloudPathAsRealPath | boolean | 否 |
+@@| url | string | 否 |
+@@| errMsg | string | 否 |
+| tempFilePaths | Array&lt;string&gt; | 是 | 
+
+### onUploadProgress: (arg: UniCloudChooseAndUploadFileProgressEvent) => void \| null @onuploadprogress
+onUploadProgress
+
+#### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| arg | **UniCloudChooseAndUploadFileProgressEvent** | 是 |
+| 名称 | 类型 | 必备 |
+| :- | :- | :- |
+| index | number | 是 |
+| loaded | number | 是 |
+| total | number | 是 |
+| tempFilePath | string | 是 |
+| tempFile | **UniCloudChooseAndUploadFileItem** | 是 |
+@@| 名称 | 类型 | 必备 |
+@@| :- | :- | :- |
+@@| name | string | 是 |
+@@| path | string | 是 |
+@@| cloudPath | string | 是 |
+@@| cloudPathAsRealPath | boolean | 否 |
+@@| url | string | 否 |
+@@| errMsg | string | 否 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| Promise\<**UniCloudChooseAndUploadFileResult**> |
+| 名称 | 类型 | 必备 |
+| :- | :- | :- |
+| tempFiles | Array&lt;**UniCloudChooseAndUploadFileItem**&gt; | 是 |
+@@| 名称 | 类型 | 必备 |
+@@| :- | :- | :- |
+@@| name | string | 是 |
+@@| path | string | 是 |
+@@| cloudPath | string | 是 |
+@@| cloudPathAsRealPath | boolean | 否 |
+@@| url | string | 否 |
+@@| errMsg | string | 否 |
+| tempFilePaths | Array&lt;string&gt; | 是 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.getTempFileURL)
+
+**注意**
+
+- 4.18之前uni-app-x在app端仅支持选择图片，即type参数仅能设为`image`。
+- 4.18及之后的版本uni-app-x在app端仅支持选择图片、视频，即type参数仅能设为`image`、`video`。
+
+## getTempFileURL(options) @gettempfileurl
+
+获取文件临时URL
+
+### getTempFileURL 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | **UniCloudGetTempFileURLOptions** | 是 |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| fileList | Array&lt;string&gt; | 是 | 文件列表 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| Promise\<**UniCloudGetTempFileURLResult**> |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| fileList | Array&lt;**UniCloudGetTempFileURLResultItem**&gt; | 是 | 文件列表 |
+@@| 名称 | 类型 | 必备 | 描述 |
+@@| :- | :- | :- | :- |
+@@| fileID | string | 是 | 文件id |
+@@| tempFileURL | string | 是 | 文件临时url |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.chooseAndUploadFile)

package/data/uniappx/api/unicloud/utils.md

@@ -0,0 +1,153 @@
+## onResponse(callback) @onresponse
+
+监听响应事件
+
+### onResponse 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | 
+
+### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| type | string | 是 | 响应事件类型 |
+| name | string | 是 | 响应事件由哪个云函数触发 |
+| content | any | 是 | 响应结果、错误内容 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.onResponse)
+
+## offResponse(callback) @offresponse
+
+移除响应事件监听
+
+### offResponse 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | 
+
+### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| type | string | 是 | 响应事件类型 |
+| name | string | 是 | 响应事件由哪个云函数触发 |
+| content | any | 是 | 响应结果、错误内容 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.offResponse)
+
+## onRefreshToken(callback) @onrefreshtoken
+
+监听token刷新事件
+
+### onRefreshToken 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| callback | (arg: [UniCloudRefreshTokenEvent](#unicloudrefreshtokenevent-values)) => any | 是 | 
+
+### UniCloudRefreshTokenEvent 的属性值 @unicloudrefreshtokenevent-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| token | string | 是 | token内容 |
+| tokenExpired | number | 是 | token过期时间 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.onRefreshToken)
+
+## offRefreshToken(callback) @offrefreshtoken
+
+移除token刷新事件监听
+
+### offRefreshToken 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| callback | (arg: [UniCloudRefreshTokenEvent](#unicloudrefreshtokenevent-values)) => any | 是 | 
+
+### UniCloudRefreshTokenEvent 的属性值 @unicloudrefreshtokenevent-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| token | string | 是 | token内容 |
+| tokenExpired | number | 是 | token过期时间 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.offRefreshToken)
+
+## getCurrentUserInfo() @getcurrentuserinfo
+
+获取token内缓存的用户信息
+
+### getCurrentUserInfo 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.61 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| **UniCloudUserInfo** |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| uid | string | 否 | 用户id |
+| role | Array<string> | 是 | 用户角色列表 |
+| permission | Array<string> | 是 | 用户权限列表 |
+| tokenExpired | number | 是 | 用户token过期时间 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.getCurrentUserInfo)
+
+## connectWebSocket() @connectWebSocket
+
+连接 WebSocket
+
+### connectWebSocket 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.24 | 4.41 | 4.28 | 4.24 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | **UniCloudConnectWebSocketOptions** | 是 |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| name | string | 是 | WebSocket云函数/云对象名称 |
+| query | UTSJSONObject | 否 | 建立连接时需要传递的参数, 仅在 connection 事件中接收到 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| SocketTask |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.connectWebSocket)