@manycore/custom-sdk 1.13.1 → 1.14.0-alpha.0

package/index.d.ts

@@ -854,6 +854,9 @@ export declare class FittingDesignService extends BaseService {
       * 保存孔/槽数据至方案
       * 如果design不传，即表示将分步保存数据存储至后端
       *
+      * 之前的孔槽会被design直接替换
+      *
+      * 如果只想展示孔槽可使用 {@link FittingDesignService.appendFittingDesign}
       * @example
       * ```typescript
       * await fittingDesignService.saveDesign({
@@ -2892,12 +2895,22 @@ export declare class FittingDesignService extends BaseService {
          * const json = await service.getModelJsonDataByModelId('请输入模型ID');
          * ```
          *
-         * > 以上 API 暂不建议在非对接 2.0 环境下使用，主要是与孔/槽方案数据存在关联关系。
-         > > 替代的 service 为`CustomDesignExportService`，将会在 9 月底最新的`@manycore/custom-miniapp-sdk`中提供。
+         * > 以上 API 暂不建议在非对接 2.0 环境下使用，主要是与孔/槽方案数据存在关联关系
+         > > 耗时API 建议后台异步请求并配合做好缓存
+         > > >替代的 service 为`CustomDesignExportService`，将会在 9 月底最新的`@manycore/custom-miniapp-sdk`中提供。
          *
-         * @example
+         * @example 最佳实践
          * ```typescript
-         * await modelService.getParamData();
+         * // 后台异步任务 串行执行不建议并发
+         * const cache = new Map<string, any>();
+         * for (const model of models) {
+         *     const { id } = model;
+         *     const data = await getParamData({ modelId: id });
+         *     cache.set(id, data)
+         * }
+         *
+         * // 主线程获取
+         * cache.get(id);
          * ```
          *
          * @param options
@@ -2905,10 +2918,19 @@ export declare class FittingDesignService extends BaseService {
         getParamData(options?: IGetParamModelJsonOption): Promise<any>;
         /**
          * 获取模型的交接数据
-         *
+         * > 耗时API 建议后台异步请求并配合做好缓存
          * @example
          * ```typescript
-         * await modelService.getParamIntersected();
+         * // 后台异步任务 串行执行不建议并发
+         * const cache = new Map<string, any>();
+         * for (const model of models) {
+         *     const { id } = model;
+         *     const data = await getParamIntersected({ modelId: id });
+         *     cache.set(id, data)
+         * }
+         *
+         * // 主线程获取
+         * cache.get(id);
          * ```
          *
          * @param options