@reskin/core 0.0.1 → 0.0.2

package/services/dictionary.service.d.ts

@@ -9,47 +9,47 @@ export declare class RkDictionaryService {
     /**
      * 通过字典编码获得常用项
      * @param code 字典编码
-     * @returns 常用项
+     * @returns 常用项数组
      */
     getUseItems(code: string): IDictionaryItem[];
     /**
      * 通过字典编码设置常用项
      * @param code 字典编码
-     * @param item 常用项
+     * @param item 常用项对象
      */
     setUseItems(code: string, item: IDictionaryItem): void;
     /**
      * 通过字典编码获得字典基本信息
      * @param code 字典编码
-     * @returns 字典基本信息
+     * @returns 字典基本信息的Observable对象
      */
     getBaseInfo(code: string): Observable<IDictionaryBaseInfo>;
     /**
-     * 通过字典编码获得获得字典项
+     * 通过字典编码获得字典项列表
      * @param code 字典编码
-     * @returns 字典项列表
+     * @returns 字典项列表的Observable对象
      */
     getData(code: string): Observable<IDictionaryItem[]>;
     /**
-     * 通过父节点获得字典项编码
+     * 通过父节点获得字典项列表
      * @param code 字典编码
-     * @param parentId 父节点编码
-     * @returns 字典项列表
+     * @param parentId 父节点编码，默认为根节点
+     * @returns 字典项列表的Observable对象
      */
     getChildData(code: string, parentId?: string): Observable<IDictionaryItem[]>;
     private codeReplace;
     /**
-     * 通过字典编码获得获得字典项
+     * 根据关键字搜索字典项
      * @param code 字典编码
      * @param keyword 关键字
-     * @returns 字典项列表
+     * @returns 最多10个匹配的字典项列表的Observable对象
      */
     requestSearchData(code: string, keyword: string): Observable<any>;
     /**
-     * 获得字典项的所有父节点
+     * 获取字典项的所有父节点
      * @param code 字典编码
      * @param id 字典项编码
-     * @returns 字典项列表
+     * @returns 父节点列表的Observable对象
      */
     requestParentList(code: string, id: string): Observable<IDictionaryItem[]>;
     static ɵfac: i0.ɵɵFactoryDeclaration<RkDictionaryService, never>;

package/services/down.file.service.d.ts

@@ -5,15 +5,23 @@ export declare class RkDownFileService {
     private http;
     constructor(http: HttpClient);
     /**
-     * 使用GET方法下载文件
-     * @param url 请求链接; url可以传递自定义文件名优先级最高;如：api/file/down?fileName=身份证.jpg
-     * @param params 请求参数
+     * 使用HTTP GET方法发送请求，以获取Blob类型的响应
+     * 此方法主要用于处理需要二进制响应的请求，如文件下载等
+     *
+     * @param url 请求的URL，必须提供，url可以传递自定义文件名优先级最高;如：api/file/down?fileName=身份证.jpg
+     * @param params 可选的查询参数，将作为URL查询字符串发送
+     * @returns 返回一个Observable，它发出HttpResponse对象，包含Blob类型的响应体
      */
     get(url: string, params?: Record<string, any>): Observable<HttpResponse<Blob>>;
     /**
-     * 使用POST方法下载文件
-     * @param url 请求链接; url可以传递自定义文件名优先级最高;如：api/file/down?fileName=身份证.jpg
-     * @param params 请求参数
+     * 发起POST请求下载数据
+     *
+     * 本函数用于向指定URL发起POST请求，并期望返回二进制数据（如文件等）
+     * 使用场景包括但不限于文件下载等需要获取原始二进制数据的操作
+     *
+     * @param url 请求的URL，必须提供，url可以传递自定义文件名优先级最高;如：api/file/down?fileName=身份证.jpg
+     * @param params 请求的参数，可以是任意类型的数据，会作为请求体发送
+     * @returns 返回一个Observable，其类型参数为HttpResponse<Blob>，表示服务器的响应
      */
     post(url: string, params?: Record<string, any>): Observable<HttpResponse<Blob>>;
     private handleResponse;

package/services/field.scheme.service.d.ts

@@ -7,9 +7,13 @@ export declare class RkFieldSchemeService {
     private appSettings;
     constructor(http: HttpClient);
     /**
-     * 通过字段方案标识符获得字段方案内容
-     * @param permission 字段方案标识符
-     * @returns 字段方案
+     * 根据权限标识符获取字段方案
+     *
+     * 此方法主要用于根据提供的权限标识符，从后端服务中获取相应的字段方案
+     * 如果应用设置中包含了地区代码，则会将其前缀添加到权限标识符上
+     *
+     * @param permission 字段方案的权限标识符，用于定位特定的字段方案
+     * @returns 返回一个Observable，其中包含字段方案的数据
      */
     getData(permission: string): Observable<IFieldScheme>;
     static ɵfac: i0.ɵɵFactoryDeclaration<RkFieldSchemeService, never>;

package/services/file.service.d.ts

@@ -7,27 +7,62 @@ export declare class RkFileService {
     private http;
     constructor(http: HttpClient);
     /**
-     * 获得人员照片静态路径
-     * @param fileId 文件编码
-     * @param fileName 文件名称
+     * 构建静态人员照片的URL
+     *
+     * 该方法用于根据文件ID构建访问静态图片的URL如果提供了文件名，
+     * 则将其作为查询参数附加到URL上这个函数主要用于前端展示静态图片，
+     * 通过传入文件的唯一标识符（fileId）和可选的文件名来确保图片的正确加载
+     *
+     * @param fileId 图片文件的唯一标识符，用于定位具体的图片资源
+     * @param fileName 可选参数，图片文件的名称如果提供，将作为查询参数附加到URL上
+     * @returns 返回构建的静态图片URL
      */
     staticPhotoUrl(fileId: string, fileName?: string): string;
     /**
-     * 上传人员照片
-     * @param data 文件
+     * 上传图片
+     *
+     * 该方法用于将图片文件上传到服务器它封装了HTTP POST请求，发送FormData对象到指定的API端点
+     * 主要用于用户头像的上传操作
+     *
+     * @param data FormData对象，包含了需要上传的文件以及其他可能的表单数据
+     * @returns 返回一个Observable对象，其类型参数为R<IUploadFileData>，表示上传操作的结果
      */
     photoUpload(data: FormData): Observable<R<IUploadFileData>>;
     /**
-     * 获得附件静态路径
-     * @param fileId 文件编码
-     * @param fileName 文件名称
+     * 构建静态文件的URL地址
+     *
+     * 本函数用于根据文件ID和可选的文件名构建访问静态文件的URL地址
+     * 如果提供了文件名，将会将其编码并附加到URL上，以便在访问时可以直接下载文件
+     *
+     * @param fileId 文件的唯一标识符，用于定位具体文件
+     * @param fileName 可选参数，文件的名称如果提供此参数，将会在URL中进行编码后附加
+     * @returns 返回构建好的静态文件URL地址
      */
     staticFileUrl(fileId: string, fileName?: string): string;
     /**
-     * 上传附件
-     * @param data 文件
+     * 上传文件
+     *
+     * 此方法用于将文件数据上传到服务器它封装了HTTP POST请求，用于文件上传服务
+     * 使用FormData对象来构建需要上传的文件数据
+     *
+     * @param data FormData对象，包含了需要上传的文件数据
+     * @returns 返回一个Observable对象，它发出包含上传结果数据的动作
      */
     fileUpload(data: FormData): Observable<R<IUploadFileData>>;
+    /**
+     * 批量上传文件
+     *
+     * 该方法负责将一组文件作为FormData发送到服务器进行批量上传
+     * 主要用于处理大量文件上传的情况，提高效率和用户体验
+     *
+     * @param data FormData对象，包含了需要上传的文件数据
+     *                这个对象通常由前端表单生成，包含了多个文件
+     * @returns 返回一个Observable对象，它发出一个结果类型为R<IUploadFileData[]>的响应
+     *             这个响应包含了上传结果的详细信息，包括成功与否，文件信息等
+     *
+     * 注意：该方法依赖于后端提供的文件上传服务，URL路径为'api/gl-file-service/attachment/batchUpload'
+     */
+    batchUpload(data: FormData): Observable<R<IUploadFileData[]>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<RkFileService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<RkFileService>;
 }

package/services/menu.service.d.ts

@@ -9,6 +9,10 @@ export declare class RkMenuService {
     constructor(http: HttpClient);
     /**
      * 获得系统导航列表
+     *
+     * 通过HTTP GET请求从后端获取系统导航数据，返回一个Observable对象
+     *
+     * @returns Observable<R<Array<IMenu>>> 包含导航菜单数据的Observable对象
      */
     requestData(): Observable<R<Array<IMenu>>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<RkMenuService, never>;

package/services/org.service.d.ts

@@ -23,7 +23,8 @@ export declare class RkOrgService {
     requestKeywordList(groupId: string, keyName: string): Observable<R<Array<Record<string, any>>>>;
     /**
      * 通过单位编码获得所有父节点
-     * @param id
+     * @param id 单位编码
+     * @returns 父节点列表
      */
     requestParentList(id: string): Observable<R<Array<IOrgTreeNode>>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<RkOrgService, never>;

package/services/scheme.service.d.ts

@@ -7,9 +7,14 @@ export declare class RkSchemeService {
     private appSettings;
     constructor(http: HttpClient);
     /**
-     * 通过界面方案标识符获得界面方案内容
-     * @param permission 界面方案标识符
-     * @returns 界面方案
+     * 根据权限标识符获取界面方案内容
+     *
+     * 此方法主要用于根据提供的权限标识符，从后端服务中获取相应的界面方案内容它首先检查是否设置了应用设置中的区域代码，
+     * 如果设置了，则将其前缀到权限标识符上，然后构造请求的URL，并调用HTTP服务进行获取在处理HTTP响应时，
+     * 它会检查返回的状态码，并在状态码不为0（成功）时抛出错误，否则返回界面方案数据
+     *
+     * @param permission 权限标识符，用于获取相应的界面方案
+     * @returns 返回一个Observable，其中包含界面方案数据
      */
     getData(permission: string): Observable<IScheme>;
     static ɵfac: i0.ɵɵFactoryDeclaration<RkSchemeService, never>;

package/utils/array.d.ts

@@ -1,5 +1,9 @@
 /**
- * 对象深拷贝
- * @param source
+ * 深克隆一个对象或数组
+ *
+ * 该函数通过递归方式深克隆输入的对象或数组，确保与原对象或数组隔离，不会相互影响
+ *
+ * @param source 需要克隆的源对象或数组
+ * @returns 返回克隆后的对象或数组
  */
 export declare function deepClone<T>(source: T): T;

package/utils/dom.d.ts

@@ -1,6 +1,11 @@
 import { Observable } from 'rxjs';
 /**
- * 监听DOM元素的大小变化
- * @param element
+ * 监听元素的大小变化
+ *
+ * 此函数创建了一个Observable，用于观察给定HTMLElement元素的大小变化它使用了ResizeObserver API来实现
+ * 当元素的大小发生变化时，会发出一个包含变化记录的数组
+ *
+ * @param element 需要观察大小变化的HTMLElement元素
+ * @returns 返回一个Observable，其中包含ResizeObserverEntry的数组，用于记录每次大小变化的信息
  */
 export declare function observeResize(element: HTMLElement): Observable<ResizeObserverEntry[]>;

package/utils/store.d.ts

@@ -12,31 +12,43 @@ export interface StoreOptions {
     expires?: number;
 }
 /**
- * 用于设置缓存值保存时key的前缀
- * @param newPrefix 前缀
+ * 设置存储前缀
+ *
+ * 该函数用于更改全局存储前缀，影响后续所有存储操作的键名前缀。
+ * 存储前缀的更改可能会影响已存储的数据被正确识别和访问。
+ *
+ * @param newPrefix 新的存储前缀字符串
  */
 export declare function setStorePrefix(newPrefix: string): void;
 /**
- * 创建缓存值
+ * 提供了一个用于缓存值的类，值可以被存储在浏览器的localStorage或sessionStorage中。
+ * 如果提供了过期时间，存储的值会在过期后自动移除。
  */
 export declare class Store<T> {
     private value;
     private readonly storage;
     private readonly expires?;
     private readonly storageKey;
+    /**
+     * 初始化Store类的实例。
+     * @param key 缓存值的键名。
+     * @param defaultValue 初始值，默认值会被存储并返回直到设置新的值。
+     * @param options 配置选项，包括存储引擎和过期时间。
+     */
     constructor(key: string, defaultValue: T, options?: StoreOptions);
     /**
-     * 获取值
+     * 获取当前缓存的值。
+     * @returns 缓存的值。
      */
     get(): T;
     /**
-     * 设置值
-     * @param newValue
+     * 设置新的缓存值。
+     * @param newValue 新的值。
      */
     set(newValue: T): void;
     /**
-     * 更新值
-     * @param updateFn
+     * 使用提供的函数更新缓存的值。
+     * @param updateFn 一个接受当前值并返回新值的函数。
      */
     update(updateFn: (currentValue: T) => T): void;
 }