nim-web-sdk-ng 10.9.80 → 10.9.90

package/README.md

@@ -34,6 +34,10 @@ dist/
     ├── CHATROOM_MINIAPP_SDK.js  v2 聊天室小程序适配版 UMD 格式
     ├── CHATROOM_UNIAPP_SDK.js   v2 聊天室 UNIAPP 适配版 UMD 格式
     ├── CHATROOM_RN_SDK.js       v2 聊天室 RN 适配版 UMD 格式
+  |── nodejs
+    ├── nim.js                   v2 IM Node.js 适配版 ESM 格式
+    ├── nim.d.ts                 TypeScript 类型定义入口
+    ├── nim/                     TypeScript 类型定义目录
   |── v1
     ├── CHATROOM_BROWSER_SDK.js  v1 聊天室浏览器适配版 UMD 格式
     ├── CHATROOM_MINIAPP_SDK.js  v1 聊天室小程序适配版 UMD 格式
@@ -77,6 +81,173 @@ async function init() {
 init()
 ```
 
+### Node.js 环境
+
+Node.js 版本专为服务端场景设计，支持在 Node.js 环境中使用 NIM SDK 的核心功能。
+
+#### 环境要求
+
+- **Node.js 版本**: >= 20.0.0（使用原生 `fetch`、`FormData`、`Blob` API）
+- **模块格式**: ESM（ES Modules）
+- **依赖**: `ws`（WebSocket 库，已包含在 SDK 依赖中）
+
+#### 安装
+
+```bash
+npm install nim-web-sdk-ng@">=10"
+```
+
+#### 引入方式
+
+```js
+// Node.js 环境专用入口
+import NIM from 'nim-web-sdk-ng/dist/nodejs/nim.js'
+```
+
+#### 支持的服务模块
+
+| 服务模块                        | 描述                             |
+| ------------------------------- | -------------------------------- |
+| `V2NIMLoginService`             | 登录服务                         |
+| `V2NIMMessageService`           | 消息服务（发送/接收消息）        |
+| `V2NIMMessageLogUtil`           | 消息日志工具（查询历史消息）     |
+| `V2NIMMessageExtendUtil`        | 消息扩展工具（快捷评论、PIN 等） |
+| `V2NIMLocalConversationService` | 本地会话服务                     |
+| `V2NIMConversationService`      | 会话服务                         |
+| `V2NIMConversationGroupService` | 会话分组服务                     |
+| `V2NIMUserService`              | 用户服务                         |
+| `V2NIMFriendService`            | 好友服务                         |
+| `V2NIMTeamService`              | 群组服务                         |
+| `V2NIMNotificationService`      | 通知服务                         |
+| `V2NIMStorageService`           | 存储服务（文件上传下载）         |
+| `V2NIMSettingService`           | 设置服务                         |
+| `V2NIMSyncService`              | 同步服务                         |
+| `V2NIMAIService`                | AI 服务                          |
+| `V2NIMSignallingService`        | 信令服务                         |
+| `V2NIMPassthroughService`       | 透传服务                         |
+
+#### 基础示例
+
+```js
+import NIM from 'nim-web-sdk-ng/dist/nodejs/nim.js'
+
+// 创建实例
+const nim = NIM.getInstance({
+  appkey: 'YOUR_APPKEY',
+  account: 'YOUR_ACCOUNT',
+  token: 'YOUR_TOKEN',
+  debugLevel: 'debug',
+  apiVersion: 'v2'
+})
+
+// 监听登录状态
+nim.V2NIMLoginService.on('onLoginStatus', (status) => {
+  console.log('登录状态:', status)
+})
+
+nim.V2NIMLoginService.on('onConnectStatus', (status) => {
+  console.log('连接状态:', status)
+})
+
+// 登录
+async function main() {
+  try {
+    await nim.V2NIMLoginService.login('YOUR_ACCOUNT', 'YOUR_TOKEN')
+    console.log('登录成功')
+
+    // 发送文本消息
+    const message = nim.V2NIMMessageCreator.createTextMessage('Hello from Node.js!')
+    const conversationId = nim.V2NIMConversationIdUtil.p2pConversationId('TARGET_ACCOUNT')
+    await nim.V2NIMMessageService.sendMessage(message, conversationId)
+    console.log('消息发送成功')
+  } catch (err) {
+    console.error('操作失败:', err)
+  }
+}
+
+main()
+```
+
+#### 发送图片消息
+
+```js
+import NIM from 'nim-web-sdk-ng/dist/nodejs/nim.js'
+import path from 'path'
+
+const nim = NIM.getInstance({
+  appkey: 'YOUR_APPKEY',
+  account: 'YOUR_ACCOUNT',
+  token: 'YOUR_TOKEN',
+  apiVersion: 'v2'
+})
+
+async function sendImage() {
+  await nim.V2NIMLoginService.login('YOUR_ACCOUNT', 'YOUR_TOKEN')
+
+  // 使用文件路径创建图片消息
+  const imagePath = path.join(process.cwd(), 'image.png')
+  const message = nim.V2NIMMessageCreator.createImageMessage(imagePath, 'image.png')
+
+  const conversationId = nim.V2NIMConversationIdUtil.p2pConversationId('TARGET_ACCOUNT')
+
+  // 发送消息，支持上传进度回调
+  const result = await nim.V2NIMMessageService.sendMessage(message, conversationId, {}, (progress) => {
+    console.log(`上传进度: ${Math.round(progress * 100)}%`)
+  })
+
+  console.log('图片发送成功:', result.attachment?.url)
+}
+
+sendImage()
+```
+
+#### 查询历史消息
+
+```js
+async function getHistory() {
+  const conversationId = nim.V2NIMConversationIdUtil.p2pConversationId('TARGET_ACCOUNT')
+
+  const messages = await nim.V2NIMMessageLogUtil.getMessageList({
+    conversationId,
+    limit: 50
+  })
+
+  messages.forEach((msg) => {
+    console.log(`[${msg.senderId}]: ${msg.text || msg.messageType}`)
+  })
+}
+```
+
+#### TypeScript 支持
+
+Node.js 版本提供完整的 TypeScript 类型定义：
+
+```typescript
+import NIM from 'nim-web-sdk-ng/dist/nodejs/nim.js'
+import type V2NIM from 'nim-web-sdk-ng/dist/nodejs/nim'
+
+const nim: V2NIM = NIM.getInstance({
+  appkey: 'YOUR_APPKEY',
+  account: 'YOUR_ACCOUNT',
+  token: 'YOUR_TOKEN',
+  apiVersion: 'v2'
+})
+```
+
+#### 注意事项
+
+1. **内存存储**: Node.js 版本使用内存实现 localStorage，数据不会持久化。进程重启后会话和消息缓存将丢失。
+
+2. **网络状态**: 网络状态检测返回固定的"已连接"状态，不支持实时网络状态变化监听。
+
+3. **电源状态**: 电源状态相关 API 为存根实现，不提供实际功能。
+
+4. **文件上传**: 支持通过文件路径上传本地文件，使用原生 `FormData` 和 `fetch` API。
+
+5. **WebSocket**: 使用 `ws` 库实现 WebSocket 连接，需确保网络环境允许 WebSocket 连接。
+
+6. **长连接管理**: 服务端场景建议实现心跳检测和断线重连逻辑，确保连接稳定性。
+
 ## IM V1
 
 ### sdk 选择

package/dist/esm/adapters.d.ts

@@ -48,7 +48,8 @@ export declare const enum HostEnvTypes {
     QQ = 106,
     JD = 107,
     KS = 108,
-    APP = 110
+    APP = 110,
+    NODEJS = 111
 }
 export declare type GetAdapterType = () => RecursivePartial<AdaptersInterface>;
 export interface AdaptersInterface {
@@ -263,9 +264,9 @@ export interface AdapterSystemInfo {
     /**
      * https://docs.popo.netease.com/lingxi/d722dd9717d940a6bff97b207bc06cb4
      *
-     * 登录 44 号字段。客户使用的 SDK 产物为，取值有: BROWSER, UNIAPP, MINIAPP, React Native
+     * 登录 44 号字段。客户使用的 SDK 产物为，取值有: BROWSER, UNIAPP, MINIAPP, React Native, NodeJs
      */
-    libEnv: 'BROWSER' | 'UNIAPP' | 'MINIAPP' | 'React Native';
+    libEnv: 'BROWSER' | 'UNIAPP' | 'MINIAPP' | 'React Native' | 'NodeJs';
     /**
      * 登录时的 42 号字段
      *

package/dist/esm/nim/src/CloudSessionServiceInterface.d.ts

@@ -16,6 +16,17 @@ export interface CloudSessionServiceInterface {
      * @locale en
      * Query the list of sessions on the server
      * @locale
+     *
+     * @example
+     * ```ts
+     * const result = await nim.cloudSession.queryCloudSessionList({
+     *   minTimestamp: 0,
+     *   maxTimestamp: Date.now(),
+     *   limit: 100,
+     *   includedLastMsg: true
+     * })
+     * console.log(result.sessionList, result.hasMore)
+     * ```
      */
     queryCloudSessionList(options: NIMEQueryCloudSessionListOptions): Promise<NIMEQueryCloudSessionListResult>;
     /**
@@ -27,6 +38,13 @@ export interface CloudSessionServiceInterface {
      * @locale en
      * Query a specified session
      * @locale
+     *
+     * @example
+     * ```ts
+     * const session = await nim.cloudSession.queryCloudSession({
+     *   sessionId: 'p2p-user123'
+     * })
+     * ```
      */
     queryCloudSession(options: NIMEQueryCloudSessionOptions): Promise<NIMECloudSession>;
     /**
@@ -38,6 +56,14 @@ export interface CloudSessionServiceInterface {
      * @locale en
      * Update a session on the server
      * @locale
+     *
+     * @example
+     * ```ts
+     * await nim.cloudSession.updateCloudSession({
+     *   sessionId: 'p2p-user123',
+     *   ext: JSON.stringify({ pinned: true })
+     * })
+     * ```
      */
     updateCloudSession(options: NIMEUpdateCloudSessionOptions): Promise<void>;
     /**
@@ -49,6 +75,13 @@ export interface CloudSessionServiceInterface {
      * @locale en
      * Delete a session on the server
      * @locale
+     *
+     * @example
+     * ```ts
+     * await nim.cloudSession.deleteCloudSessionList({
+     *   sessionIdList: ['p2p-user123', 'team-456']
+     * })
+     * ```
      */
     deleteCloudSessionList(options: NIMEDeleteCloudSessionListOptions): Promise<void>;
 }

package/dist/esm/nim/src/CloudStorageServiceInterface.d.ts

@@ -15,6 +15,16 @@ export interface CloudStorageServiceInterface {
      * @locale en
      * Upload files
      * @locale
+     *
+     * @example
+     * ```ts
+     * const result = await nim.cloudStorage.uploadFile({
+     *   file: fileInput.files[0],
+     *   type: 'image',
+     *   onProgress: (progress) => console.log(progress.percentageText)
+     * })
+     * console.log(result.url)
+     * ```
      */
     uploadFile(options: IUploadFileOptions): Promise<UploadFileResult>;
     /**
@@ -26,6 +36,11 @@ export interface CloudStorageServiceInterface {
      * @locale en
      * Convert a shortened URL to a full URL.
      * @locale
+     *
+     * @example
+     * ```ts
+     * const fullUrl = await nim.cloudStorage.getOriginUrl('https://short.url/abc')
+     * ```
      * */
     getOriginUrl(options: string): Promise<string>;
     /**
@@ -36,6 +51,17 @@ export interface CloudStorageServiceInterface {
      * @locale en
      * Get the token for the authorization of file access.
      * @locale
+     *
+     * @example
+     * ```ts
+     * // 获取全局token
+     * const globalToken = await nim.cloudStorage.getFileToken({ type: 2 })
+     * // 获取url鉴权token
+     * const urlToken = await nim.cloudStorage.getFileToken({
+     *   type: 3,
+     *   urls: ['https://example.com/file1', 'https://example.com/file2']
+     * })
+     * ```
      */
     getFileToken(options: GetFileTokenOptions): Promise<GetFileTokenResult | void>;
 }

package/dist/esm/nim/src/EventServiceInterface.d.ts

@@ -98,6 +98,17 @@ export interface EventServiceInterface {
      *
      * Combine unSubscribeEventsByAccounts and unSubscribeEventsByType of IM1
      * @locale
+     *
+     * @example
+     * ```ts
+     * // 取消订阅指定账户
+     * const result = await nim.event.unSubscribeEvents({
+     *   type: 1,
+     *   accounts: ['user1', 'user2']
+     * })
+     * // 取消订阅该类型下所有账户
+     * await nim.event.unSubscribeEvents({ type: 1 })
+     * ```
      */
     unSubscribeEvents(options: UnSubscribeEventsOptions): Promise<UnSubscribeEventsResult>;
     /**
@@ -111,6 +122,17 @@ export interface EventServiceInterface {
      *
      * Combine querySubscribeEventsByAccounts and querySubscribeEventsByType of IM1
      * @locale
+     *
+     * @example
+     * ```ts
+     * // 查询指定账户的订阅关系
+     * const subscriptions = await nim.event.querySubscribeEvents({
+     *   type: 1,
+     *   accounts: ['user1', 'user2']
+     * })
+     * // 查询该类型下所有订阅关系
+     * const allSubs = await nim.event.querySubscribeEvents({ type: 1 })
+     * ```
      */
     querySubscribeEvents(options: QuerySubscribeEventsOptions): Promise<MsgEventSubscribe[]>;
 }

package/dist/esm/nim/src/FriendServiceInterface.d.ts

@@ -14,6 +14,11 @@ export interface FriendServiceInterface {
      * @locale en
      * Get friend list
      * @locale
+     *
+     * @example
+     * ```ts
+     * const friends = await nim.friend.getFriends()
+     * ```
      */
     getFriends(): Promise<FriendProfile[]>;
     /**
@@ -35,9 +40,13 @@ export interface FriendServiceInterface {
      * Add as friends directly
      *
      * After user A (the currently logged-in user) directly add user B as a friend, user B does not need to approve it and directly becomes the friend of user A.
-     * User B will receive a system notification whose type is friendRequest and attach.type is addFriend.
-     * The value of the “from” field of this type of system notification is the account of the sender (in this case, user A). And the value of the “to” field is the account of the receiver (in this case, user B).
+     * The value of the "from" field of this type of system notification is the account of the sender (in this case, user A). And the value of the "to" field is the account of the receiver (in this case, user B).
      * @locale
+     *
+     * @example
+     * ```ts
+     * const friend = await nim.friend.addFriend({ account: 'accid1', ps: '我是xxx' })
+     * ```
      */
     addFriend(options: AddFriendOptions): Promise<FriendProfile>;
     /**
@@ -56,6 +65,11 @@ export interface FriendServiceInterface {
      * After user A (sender) sends a friend to User B (receiver), user B will receive a system notification whose type is friendRequest and attach.type is applyFriend.
      * After receiving the friend request, user B can approve or reject the friend request.
      * @locale
+     *
+     * @example
+     * ```ts
+     * await nim.friend.applyFriend({ account: 'accid1', ps: '请求加为好友' })
+     * ```
      */
     applyFriend(options: ApplyFriendOptions): Promise<void>;
     /**
@@ -81,6 +95,11 @@ export interface FriendServiceInterface {
      *
      * After user B approves the friend request, user A will receive a system notification whose type is friendRequest, attach.type is passFriendApply,
      * @locale
+     *
+     * @example
+     * ```ts
+     * await nim.friend.passFriendApply({ idServer: '123456', from: 'applicantAccid' })
+     * ```
      */
     passFriendApply(options: PassFriendApplyOptions): Promise<void>;
     /**
@@ -101,6 +120,11 @@ export interface FriendServiceInterface {
      *
      * After user B rejects the friend request, user A will receive a system notification whose type is friendRequest and attach.type is rejectFriendApply.
      * @locale
+     *
+     * @example
+     * ```ts
+     * await nim.friend.rejectFriendApply({ idServer: '123456', from: 'applicantAccid', ps: '拒绝原因' })
+     * ```
      */
     rejectFriendApply(options: RejectFriendApplyOptions): Promise<void>;
     /**
@@ -124,6 +148,11 @@ export interface FriendServiceInterface {
      * After user B deletes user A from user B’s friend list, user A will receive a system notification whose type is deleteFriend.
      * The value of the “from” field of this type of system notification is the account of the person who deletes their friend (in this case, user B); and the value of the “to” field is the account of the deleted person (in this case, user A).
      * @locale
+     *
+     * @example
+     * ```ts
+     * await nim.friend.deleteFriend({ account: 'accid1', delAlias: true })
+     * ```
      */
     deleteFriend(options: DeleteFriendOptions): Promise<void>;
     /**
@@ -145,6 +174,11 @@ export interface FriendServiceInterface {
      *
      * Only remarks and extension fields can be updated.
      * @locale
+     *
+     * @example
+     * ```ts
+     * await nim.friend.updateFriend({ account: 'accid1', alias: '备注名', ext: '扩展字段' })
+     * ```
      */
     updateFriend(options: UpdateFriendOptions): Promise<void>;
 }

package/dist/esm/nim/src/MiscServiceInterface.d.ts

@@ -13,6 +13,12 @@ export interface MiscServiceInterface {
      *
      * @locale en
      * @locale
+     *
+     * @example
+     * ```ts
+     * const serverTime = await nim.misc.getServerTime()
+     * console.log('Server time:', new Date(serverTime))
+     * ```
      */
     getServerTime(): Promise<number>;
 }

package/dist/esm/nim/src/MsgLogServiceInterface.d.ts

@@ -16,6 +16,11 @@ export interface MsgLogServiceInterface {
      * 要想让下次同步时不再接到这个会话:
      * 1. resetSessionUnreadCount 重置过这个会话的已读信息
      * 2. deleteRoamingMsgs 删除服务器漫游消息
+     *
+     * @example
+     * ```js
+     * await nim.msgLog.deleteRoamingMsgs({ ids: ['p2p-accid1', 'team-12345'] })
+     * ```
      * @locale
      *
      * @locale en
@@ -125,6 +130,11 @@ export interface MsgLogServiceInterface {
      * <ul>
      * <li><a href="https://github.com/netease-im/im-code-example-web/blob/master/im-elite/session/%E5%88%A0%E9%99%A4%E4%BC%9A%E8%AF%9D.js" target="_blank">删除会话</a></li>
      * </ul>
+     *
+     * @example
+     * ```js
+     * await nim.msgLog.clearHistoryMsgsFromServer({ scene: 'p2p', to: 'accid1' })
+     * ```
      * @locale
      *
      * @locale en

package/dist/esm/nim/src/MsgServiceInterface.d.ts

@@ -55,6 +55,15 @@ export interface MsgServiceInterface {
      *
      * Reminder messages are used for status reminders in the session, such as the welcome message when entering the session, the prompt message after the session hits a sensitive word, etc.
      * @locale
+     *
+     * @example
+     * ```ts
+     * const msg = await nim.msg.sendTipMsg({
+     *   scene: 'p2p',
+     *   to: 'accid',
+     *   body: '欢迎进入会话'
+     * })
+     * ```
      */
     sendTipMsg(options: ISendTipMsgOptions): Promise<IMMessage>;
     /**
@@ -111,6 +120,15 @@ export interface MsgServiceInterface {
      * @locale en
      * Send custom messages
      * @locale
+     *
+     * @example
+     * ```ts
+     * const msg = await nim.msg.sendCustomMsg({
+     *   scene: 'p2p',
+     *   to: 'accid',
+     *   attach: JSON.stringify({ type: 'emoji', emoji: '😀' })
+     * })
+     * ```
      */
     sendCustomMsg(options: ISendCustomMsgOptions): Promise<IMMessage>;
     /**
@@ -533,6 +551,13 @@ export interface MsgServiceInterface {
      *
      * If you log in to the same account on multiple devices at the same time, the current device and the other devices will receive a one-way deletion event.
      * @locale
+     *
+     * @example
+     * ```ts
+     * const result = await nim.msg.deleteSelfMsgs({
+     *   msgs: [{ idClient: 'xxx', idServer: 'yyy', from: 'accid1', to: 'accid2', time: 1234567890 }]
+     * })
+     * ```
      */
     deleteSelfMsgs(options: DeleteSelfMsgsOptions): Promise<DeleteSelfMsgsResult[]>;
     /**
@@ -619,6 +644,15 @@ export interface MsgServiceInterface {
      * @locale en
      * Send message receipt for a group message
      * @locale
+     *
+     * @example
+     * ```ts
+     * await nim.msg.sendTeamMsgReceipt({
+     *   teamMsgReceipts: [
+     *     { idClient: 'xxx', idServer: 'yyy', teamId: '12345' }
+     *   ]
+     * })
+     * ```
      */
     sendTeamMsgReceipt(options: SendTeamMsgReceiptOptions): Promise<void>;
     /**

package/dist/esm/nim/src/OfflinePushInterface.d.ts

@@ -13,6 +13,18 @@ export interface OfflinePushServiceInterface {
      *
      * @locale en
      * @locale
+     *
+     * @example
+     * ```ts
+     * nim.offlinePush.setOfflinePushConfig({
+     *   plugin: NIMUniPlugin,
+     *   authConfig: {
+     *     xmAppId: 'YOUR_XIAOMI_APP_ID',
+     *     xmAppKey: 'YOUR_XIAOMI_APP_KEY',
+     *     xmCertificateName: 'YOUR_XIAOMI_CERT_NAME'
+     *   }
+     * })
+     * ```
      */
     setOfflinePushConfig(options: NIMESetOfflinePushConfigOptions): void;
 }
@@ -129,7 +141,7 @@ export interface NIMEOfflinePushAuthConfig {
  * @locale
  *
  * @locale en
- * Dedicated for push notification; update and upload the device token of the manufacturer’s push notification services (APNs, Xiaomi push, etc.)
+ * Dedicated for push notification; update and upload the device token of the manufacturer's push notification services (APNs, Xiaomi push, etc.)
  * @locale
  */
 export interface NIMEUpdatePushTokenOptions {

package/dist/esm/nim/src/PassThroughServiceInterface.d.ts

@@ -14,6 +14,16 @@ export interface PassThroughServiceInterface {
      * @locale en
      * Transparent transmission protocol
      * @locale
+     *
+     * @example
+     * ```ts
+     * const result = await nim.passThrough.request({
+     *   path: '/api/custom/endpoint',
+     *   method: 2, // POST
+     *   header: JSON.stringify({ 'Content-Type': 'application/json' }),
+     *   body: JSON.stringify({ key: 'value' })
+     * })
+     * ```
      */
     request(options: RequestProxyOptions): Promise<RequestProxyResult>;
 }

package/dist/esm/nim/src/PluginServiceInterface.d.ts

@@ -18,6 +18,14 @@ export interface PluginServiceInterface {
      *
      * Note: It is recommended that you use the HTTP interface to obtain a list of available connection addresses. See the server documentation for details.
      * @locale
+     *
+     * @example
+     * ```ts
+     * const addresses = await nim.plugin.getChatroomAddress({
+     *   chatroomId: '12345',
+     *   ipType: 0 // IPv4
+     * })
+     * ```
      */
     getChatroomAddress(options: GetChatroomAddressOptions): Promise<string[]>;
     /**
@@ -33,6 +41,11 @@ export interface PluginServiceInterface {
      *
      * Note: It is recommended that you use the HTTP interface to obtain a list of available connection addresses. See the server documentation for details.
      * @locale
+     *
+     * @example
+     * ```ts
+     * const addresses = await nim.plugin.getQChatAddress({ ipType: 0 })
+     * ```
      */
     getQChatAddress(options?: GetQChatAddressOptions): Promise<string[]>;
 }

package/dist/esm/nim/src/QChatMediaServiceInterface.d.ts

@@ -8,14 +8,32 @@ import { NEDeviceBaseInfo, NEDeviceSwitchInfo } from 'neroom-web-sdk';
 export interface QChatMediaServiceInterface {
     /**
      * 初始化
+     *
+     * @example
+     * ```ts
+     * await qchat.qchatMedia.initQChatMedia({ debug: false })
+     * ```
      */
     initQChatMedia(options: InitOptions): Promise<void>;
     /**
      * 登录圈组多媒体服务，必须先初始化后在调用该接口
+     *
+     * @example
+     * ```ts
+     * await qchat.qchatMedia.loginByIM()
+     * ```
      */
     loginByIM(): Promise<void>;
     /**
      * 连接圈组多媒体频道（房间）,必须先登录后再调用该接口
+     *
+     * @example
+     * ```ts
+     * await qchat.qchatMedia.connectChannel({
+     *   serverId: '123456',
+     *   channelId: '789'
+     * })
+     * ```
      */
     connectChannel(options: ConnectOptions): Promise<void>;
     /**

package/dist/esm/nim/src/QChatMsgServiceInterface.d.ts

@@ -275,10 +275,11 @@ export interface IUploadFileOptions {
     /**
      * maxSize 限制文件大小。
      *
-     * 只对浏览器生效。
+     * 对浏览器生效(v10.0.0+)
      *
-     * uni-app，小程序等，由于sdk只能得到一个 filePath 临时路径，不能得到整个文件的信息。
-     * 所以请开发者自行在选择文件后进行判断，参考那些端的API如 wx.chooseImage，uni.chooseImage
+     * 而在 uni-app、小程序等 filePath 上传场景中，调用 stat 方法检测生效 (v10.9.90+)。
+     *
+     * 若宿主环境不支持文件大小探查，则仍建议开发者在选择文件后自行判断，参考 wx.chooseImage、uni.chooseImage 等端能力。
      */
     maxSize?: number;
     /**