node-nim 10.5.2 → 10.6.0

package/dist/v2/v2_nim_storage_service.js

@@ -12,21 +12,46 @@ class V2NIMStorageService extends eventemitter3_1.EventEmitter {
         super();
         this.instance = new loader_1.default.V2NIMStorageService({ emit: this.emit.bind(this) }, instanceId);
     }
-    /** @brief 添加自定义存储场景, 需在登录前调用 */
-    /** @param sceneName 自定义存储场景 */
-    /** @return void */
+    /**
+     * @brief 添加自定义存储场景, 需在登录前调用
+     * @param sceneName 自定义存储场景
+     * @return void
+     * @example
+     * ```javascript
+     * v2.storageService.addCustomStorageScene(sceneName, expireTime)
+     * ```
+     */
     addCustomStorageScene(sceneName, expireTime) {
         this.instance.addCustomStorageScene(sceneName, expireTime);
     }
-    /** @brief 创建文件上传任务 */
-    /** @param fileParams 文件上传的相关参数 */
-    /** @return V2NIMUploadFileTask */
+    /**
+     * @brief 创建文件上传任务
+     * @param fileParams 文件上传的相关参数
+     * @return V2NIMUploadFileTask
+     * @example
+     * ```javascript
+     * const task = v2.storageService.createUploadFileTask({
+     *     filePath: 'file_path'
+     * })
+     * ```
+     */
     createUploadFileTask(fileParams) {
         return this.instance.createUploadFileTask(fileParams);
     }
-    /** @brief 文件上传 */
-    /** @param fileParams 文件上传的相关参数 */
-    /** @return Primise<string> */
+    /**
+     * @brief 文件上传
+     * @param fileTask 文件上传任务
+     * @returns Promise<string>
+     * @example
+     * ```javascript
+     * const url = await v2.storageService.uploadFile({
+     *     taskId: 'task_id',
+     *     uploadParams: {
+     *         filePath: 'file_path'
+     *     }
+     * })
+     * ```
+     */
     uploadFile(fileTask) {
         return new Promise((resolve, reject) => {
             this.instance.uploadFile(fileTask, (url) => {
@@ -36,9 +61,17 @@ class V2NIMStorageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 取消文件上传 */
-    /** @param uploadId 文件上传任务 id */
-    /** @return void */
+    /**
+     * @brief 取消文件上传
+     * @param fileTask 文件上传任务
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.storageService.cancelUploadFile({
+     *     taskId: 'task_id'
+     * })
+     * ```
+     */
     cancelUploadFile(fileTask) {
         return new Promise((resolve, reject) => {
             this.instance.cancelUploadFile(fileTask, () => {
@@ -48,11 +81,17 @@ class V2NIMStorageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 下载文件 */
-    /** @param url 文件下载地址 */
-    /** @param filePath 文件保存路径 */
-    /** @param progressCallback 下载进度回调 */
-    /** @return Promise<void> 下载文件的 Promise 对象 */
+    /**
+     * @brief 下载文件
+     * @param url 文件下载地址
+     * @param filePath 文件保存路径
+     * @param progressCallback 下载进度回调
+     * @returns Promise<string> 下载文件的 Promise 对象
+     * @example
+     * ```javascript
+     * const savePath = await v2.storageService.downloadFile(url, filePath, progressCallback)
+     * ```
+     */
     downloadFile(url, filePath, progressCallback) {
         return new Promise((resolve, reject) => {
             this.instance.downloadFile(url, filePath, (savePath) => {
@@ -64,9 +103,15 @@ class V2NIMStorageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 取消下载文件 */
-    /** @param url 文件下载地址 */
-    /** @return Promise<void> 取消下载文件的 Promise 对象 */
+    /**
+     * @brief 取消下载文件
+     * @param url 文件下载地址
+     * @returns Promise<void> 取消下载文件的 Promise 对象
+     * @example
+     * ```javascript
+     * await v2.storageService.cancelDownloadFile(url)
+     * ```
+     */
     cancelDownloadFile(url) {
         return new Promise((resolve, reject) => {
             this.instance.cancelDownloadFile(url, () => {
@@ -76,14 +121,25 @@ class V2NIMStorageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 查询存储场景列表 */
-    /** @return Array<V2NIMStorageScene> */
+    /**
+     * @brief 查询存储场景列表
+     * @returns Array<V2NIMStorageScene>
+     * @example
+     * ```javascript
+     * const scenes = v2.storageService.getStorageSceneList()
+     * ```
+     */
     getStorageSceneList() {
         return this.instance.getStorageSceneList();
     }
-    /** @brief 长链接转短链接 */
-    /** @param shortUrl 短链接地址 */
-    /** @return Promise<string> 长链接的 Promise 对象 */
+    /** @brief 长链接转短链接
+     * @param shortUrl 短链接地址
+     * @returns Promise<string> 长链接的 Promise 对象
+     * @example
+     * ```javascript
+     * const longUrl = await v2.storageService.shortUrlToLong(shortUrl)
+     * ```
+     */
     shortUrlToLong(shortUrl) {
         return new Promise((resolve, reject) => {
             this.instance.shortUrlToLong(shortUrl, (longUrl) => {
@@ -93,10 +149,21 @@ class V2NIMStorageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 下载消息附件 */
-    /** @param downloadParam 下载参数 */
-    /** @param progress 下载进度回调 */
-    /** @return Promise<string> 下载文件的 Promise 对象 */
+    /**
+     * @brief 下载消息附件
+     * @param downloadParam 下载参数
+     * @param progress 下载进度回调
+     * @returns Promise<string> 下载文件的 Promise 对象
+     * @example
+     * ```javascript
+     * const savePath = await v2.storageService.downloadAttachment({
+     *     attachment,
+     *     type: 0,
+     * }, (progress) => {
+     *     console.log(progress)
+     * })
+     * ```
+     */
     downloadAttachment(downloadParam, progress) {
         return new Promise((resolve, reject) => {
             this.instance.downloadAttachment(downloadParam, (savePath) => {
@@ -108,10 +175,16 @@ class V2NIMStorageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 获取图片消息中的图片缩略图 */
-    /** @param attachment 消息附件 */
-    /** @param thumbSize 图片缩略图的尺寸，若不指定则使用默认 150x150 */
-    /** @return Promise<V2NIMGetMediaResourceInfoResult> 获取图片缩略图的 Promise 对象 */
+    /**
+     * @brief 获取图片消息中的图片缩略图
+     * @param attachment 消息附件
+     * @param thumbSize 图片缩略图的尺寸，若不指定则使用默认 150x150
+     * @returns Promise<V2NIMGetMediaResourceInfoResult> 获取图片缩略图的 Promise 对象
+     * @example
+     * ```javascript
+     * const result = await v2.storageService.getImageThumbUrl(attachment, thumbSize)
+     * ```
+     */
     getImageThumbUrl(attachment, thumbSize) {
         return new Promise((resolve, reject) => {
             this.instance.getImageThumbUrl(attachment, thumbSize, (result) => {
@@ -121,10 +194,16 @@ class V2NIMStorageService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 获取视频消息中的视频缩略图 */
-    /** @param attachment 消息附件 */
-    /** @param thumbSize 视频缩略图的尺寸，若不指定则使用默认 150x150 */
-    /** @return Promise<V2NIMGetMediaResourceInfoResult> 获取视频缩略图的 Promise 对象 */
+    /**
+     * @brief 获取视频消息中的视频缩略图
+     * @param attachment 消息附件
+     * @param thumbSize 视频缩略图的尺寸，若不指定则使用默认 150x150
+     * @returns Promise<V2NIMGetMediaResourceInfoResult> 获取视频缩略图的 Promise 对象
+     * @example
+     * ```javascript
+     * const result = await v2.storageService.getVideoCoverUrl(attachment, thumbSize)
+     * ```
+     */
     getVideoCoverUrl(attachment, thumbSize) {
         return new Promise((resolve, reject) => {
             this.instance.getVideoCoverUrl(attachment, thumbSize, (result) => {

package/dist/v2/v2_nim_storage_service.js.map

@@ -1 +1 @@
-{"version":3,"file":"v2_nim_storage_service.js","sourceRoot":"","sources":["../../ts/v2/v2_nim_storage_service.ts"],"names":[],"mappings":";;;;;;AAUA,uDAA2B;AAC3B,iDAA0C;AAM1C,kBAAkB;AAClB,MAAa,mBAAoB,SAAQ,4BAAuC;IAG5E,YAAY,UAAmB;QAC3B,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,mBAAmB,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAC,EAAE,UAAU,CAAC,CAAA;IACzF,CAAC;IAED,gCAAgC;IAChC,+BAA+B;IAC/B,mBAAmB;IACnB,qBAAqB,CAAC,SAAiB,EAAE,UAAkB;QACvD,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;IAC9D,CAAC;IAED,sBAAsB;IACtB,kCAAkC;IAClC,kCAAkC;IAClC,oBAAoB,CAAC,UAAiC;QAClD,OAAO,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAA;IACzD,CAAC;IAED,kBAAkB;IAClB,kCAAkC;IAClC,8BAA8B;IAC9B,UAAU,CAAC,QAA6B;QACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,UAAU,CACpB,QAAQ,EACR,CAAC,GAAW,EAAE,EAAE;gBACZ,OAAO,CAAC,GAAG,CAAC,CAAA;YAChB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oBAAoB;IACpB,gCAAgC;IAChC,mBAAmB;IACnB,gBAAgB,CAAC,QAA6B;QAC1C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAC1B,QAAQ,EACR,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,kBAAkB;IAClB,wBAAwB;IACxB,6BAA6B;IAC7B,qCAAqC;IACrC,6CAA6C;IAC7C,YAAY,CAAC,GAAW,EAAE,QAAgB,EAAE,gBAAuC;QAC/E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,YAAY,CACtB,GAAG,EACH,QAAQ,EACR,CAAC,QAAgB,EAAE,EAAE;gBACjB,OAAO,CAAC,QAAQ,CAAC,CAAA;YACrB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,QAAgB,EAAE,EAAE;gBACjB,gBAAgB,CAAC,QAAQ,CAAC,CAAA;YAC9B,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oBAAoB;IACpB,wBAAwB;IACxB,+CAA+C;IAC/C,kBAAkB,CAAC,GAAW;QAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAC5B,GAAG,EACH,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,sBAAsB;IACtB,uCAAuC;IACvC,mBAAmB;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAA;IAC9C,CAAC;IAED,qBAAqB;IACrB,4BAA4B;IAC5B,8CAA8C;IAC9C,cAAc,CAAC,QAAgB;QAC3B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,cAAc,CACxB,QAAQ,EACR,CAAC,OAAe,EAAE,EAAE;gBAChB,OAAO,CAAC,OAAO,CAAC,CAAA;YACpB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oBAAoB;IACpB,gCAAgC;IAChC,6BAA6B;IAC7B,+CAA+C;IAC/C,kBAAkB,CAAC,aAAmD,EAAE,QAA+B;QACnG,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAC5B,aAAa,EACb,CAAC,QAAgB,EAAE,EAAE;gBACjB,OAAO,CAAC,QAAQ,CAAC,CAAA;YACrB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,IAAY,EAAE,EAAE;gBACb,QAAQ,CAAC,IAAI,CAAC,CAAA;YAClB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,2BAA2B;IAC3B,6BAA6B;IAC7B,kDAAkD;IAClD,2EAA2E;IAC3E,gBAAgB,CAAC,UAAkC,EAAE,SAAqB;QACtE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAC1B,UAAU,EACV,SAAS,EACT,CAAC,MAAuC,EAAE,EAAE;gBACxC,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,2BAA2B;IAC3B,6BAA6B;IAC7B,kDAAkD;IAClD,2EAA2E;IAC3E,gBAAgB,CAAC,UAAkC,EAAE,SAAqB;QACtE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAC1B,UAAU,EACV,SAAS,EACT,CAAC,MAAuC,EAAE,EAAE;gBACxC,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ;AAjLD,kDAiLC"}
+{"version":3,"file":"v2_nim_storage_service.js","sourceRoot":"","sources":["../../ts/v2/v2_nim_storage_service.ts"],"names":[],"mappings":";;;;;;AAUA,uDAA2B;AAC3B,iDAA4C;AAM5C,kBAAkB;AAClB,MAAa,mBAAoB,SAAQ,4BAAkC;IAGzE,YAAa,UAAmB;QAC9B,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;IACzF,CAAC;IAED;;;;;;;;OAQG;IACH,qBAAqB,CAAE,SAAiB,EAAE,UAAkB;QAC1D,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;IAC5D,CAAC;IAED;;;;;;;;;;OAUG;IACH,oBAAoB,CAAE,UAAiC;QACrD,OAAO,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAA;IACvD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAE,QAA6B;QACvC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,UAAU,CACtB,QAAQ,EACR,CAAC,GAAW,EAAE,EAAE;gBACd,OAAO,CAAC,GAAG,CAAC,CAAA;YACd,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CAAE,QAA6B;QAC7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAC5B,QAAQ,EACR,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CAAE,GAAW,EAAE,QAAgB,EAAE,gBAAuC;QAClF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,YAAY,CACxB,GAAG,EACH,QAAQ,EACR,CAAC,QAAgB,EAAE,EAAE;gBACnB,OAAO,CAAC,QAAQ,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,EACD,CAAC,QAAgB,EAAE,EAAE;gBACnB,gBAAgB,CAAC,QAAQ,CAAC,CAAA;YAC5B,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,kBAAkB,CAAE,GAAW;QAC7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAC9B,GAAG,EACH,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAA;IAC5C,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAE,QAAgB;QAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAC1B,QAAQ,EACR,CAAC,OAAe,EAAE,EAAE;gBAClB,OAAO,CAAC,OAAO,CAAC,CAAA;YAClB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAAE,aAAmD,EAAE,QAA+B;QACtG,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAC9B,aAAa,EACb,CAAC,QAAgB,EAAE,EAAE;gBACnB,OAAO,CAAC,QAAQ,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,EACD,CAAC,IAAY,EAAE,EAAE;gBACf,QAAQ,CAAC,IAAI,CAAC,CAAA;YAChB,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAE,UAAkC,EAAE,SAAqB;QACzE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAC5B,UAAU,EACV,SAAS,EACT,CAAC,MAAuC,EAAE,EAAE;gBAC1C,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAE,UAAkC,EAAE,SAAqB;QACzE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAC5B,UAAU,EACV,SAAS,EACT,CAAC,MAAuC,EAAE,EAAE;gBAC1C,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAhQD,kDAgQC"}

package/dist/v2/v2_nim_subscription_service.js

@@ -12,9 +12,17 @@ class V2NIMSubscriptionService extends eventemitter3_1.EventEmitter {
         super();
         this.instance = new loader_1.default.V2NIMSubscriptionService({ emit: this.emit.bind(this) });
     }
-    /** @brief 订阅用户状态 */
-    /** @param option 订阅用户状态选项 */
-    /** @return Promise<string[]> */
+    /**
+     * @brief 订阅用户状态
+     * @param option 订阅用户状态选项
+     * @returns Promise<string[]>
+     * @example
+     * ```javascript
+     * const result = await v2.subscriptionService.subscribeUserStatus({
+     *     accountIds: ['account1', 'account2'],
+     * })
+     * ```
+     */
     subscribeUserStatus(option) {
         return new Promise((resolve, reject) => {
             this.instance.subscribeUserStatus(option, (result) => {
@@ -24,9 +32,17 @@ class V2NIMSubscriptionService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 取消用户状态订阅 */
-    /** @param option 取消订阅用户状态选项 */
-    /** @return Promise<string[]> */
+    /**
+     * @brief 取消用户状态订阅
+     * @param option 取消订阅用户状态选项
+     * @returns Promise<string[]>
+     * @example
+     * ```javascript
+     * const result = await v2.subscriptionService.unsubscribeUserStatus({
+     *     accountIds: ['account1', 'account2'],
+     * })
+     * ```
+     */
     unsubscribeUserStatus(option) {
         return new Promise((resolve, reject) => {
             this.instance.unsubscribeUserStatus(option, (result) => {
@@ -36,9 +52,18 @@ class V2NIMSubscriptionService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 发布用户自定义状态 */
-    /** @param params 发布自定义用户状态参数 */
-    /** @return Promise<V2NIMCustomUserStatusPublishResult> */
+    /**
+     * @brief 发布用户自定义状态
+     * @param params 发布自定义用户状态参数
+     * @returns Promise<V2NIMCustomUserStatusPublishResult>
+     * @example
+     * ```javascript
+     * const result = await v2.subscriptionService.publishCustomUserStatus({
+     *     statusType: 10001,
+     *     duration: 60
+     * })
+     * ```
+     */
     publishCustomUserStatus(params) {
         return new Promise((resolve, reject) => {
             this.instance.publishCustomUserStatus(params, (result) => {
@@ -48,9 +73,14 @@ class V2NIMSubscriptionService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 查询用户状态订阅关系 */
-    /** @param accountIds 账号列表 */
-    /** @return Promise<V2NIMUserStatusSubscribeResult[]> */
+    /** @brief 查询用户状态订阅关系
+     * @param accountIds 账号列表
+     * @returns Promise<V2NIMUserStatusSubscribeResult[]>
+     * @example
+     * ```javascript
+     * const result = await v2.subscriptionService.queryUserStatusSubscriptions(['account1', 'account2'])
+     * ```
+     */
     queryUserStatusSubscriptions(accountIds) {
         return new Promise((resolve, reject) => {
             this.instance.queryUserStatusSubscriptions(accountIds, (result) => {

package/dist/v2/v2_nim_subscription_service.js.map

@@ -1 +1 @@
-{"version":3,"file":"v2_nim_subscription_service.js","sourceRoot":"","sources":["../../ts/v2/v2_nim_subscription_service.ts"],"names":[],"mappings":";;;;;;AASA,uDAA2B;AAC3B,iDAA0C;AAM1C,kBAAkB;AAClB,MAAa,wBAAyB,SAAQ,4BAA4C;IAGtF;QACI,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,wBAAwB,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAC,CAAC,CAAA;IAClF,CAAC;IAED,oBAAoB;IACpB,6BAA6B;IAC7B,gCAAgC;IAChC,mBAAmB,CAAC,MAAsC;QACtD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAC7B,MAAM,EACN,CAAC,MAAgB,EAAE,EAAE;gBACjB,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,sBAAsB;IACtB,+BAA+B;IAC/B,gCAAgC;IAChC,qBAAqB,CAAC,MAAwC;QAC1D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAC/B,MAAM,EACN,CAAC,MAAgB,EAAE,EAAE;gBACjB,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,uBAAuB;IACvB,gCAAgC;IAChC,0DAA0D;IAC1D,uBAAuB,CAAC,MAAmC;QACvD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CACjC,MAAM,EACN,CAAC,MAA0C,EAAE,EAAE;gBAC3C,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,wBAAwB;IACxB,6BAA6B;IAC7B,wDAAwD;IACxD,4BAA4B,CAAC,UAAoB;QAC7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,4BAA4B,CACtC,UAAU,EACV,CAAC,MAAwC,EAAE,EAAE;gBACzC,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ;AA3ED,4DA2EC"}
+{"version":3,"file":"v2_nim_subscription_service.js","sourceRoot":"","sources":["../../ts/v2/v2_nim_subscription_service.ts"],"names":[],"mappings":";;;;;;AASA,uDAA2B;AAC3B,iDAA4C;AAM5C,kBAAkB;AAClB,MAAa,wBAAyB,SAAQ,4BAAuC;IAGnF;QACE,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,wBAAwB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,mBAAmB,CAAE,MAAsC;QACzD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAC/B,MAAM,EACN,CAAC,MAAgB,EAAE,EAAE;gBACnB,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB,CAAE,MAAwC;QAC7D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CACjC,MAAM,EACN,CAAC,MAAgB,EAAE,EAAE;gBACnB,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAE,MAAmC;QAC1D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CACnC,MAAM,EACN,CAAC,MAA0C,EAAE,EAAE;gBAC7C,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,4BAA4B,CAAE,UAAoB;QAChD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,4BAA4B,CACxC,UAAU,EACV,CAAC,MAAwC,EAAE,EAAE;gBAC3C,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAzGD,4DAyGC"}