zzz-pc-view 0.0.11 → 0.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zzz-pc-view",
3
- "version": "0.0.11",
3
+ "version": "0.0.12",
4
4
  "main": "src/index.umd.js",
5
5
  "module": "src/index.es.js",
6
6
  "types": "src/index.d.ts",
@@ -22,11 +22,20 @@ interface StoreType<T extends TypeWithPrototype = TypeWithPrototype> {
22
22
  [storeKey]: Store<T>;
23
23
  }
24
24
  /**
25
- * API 列表的接口,包含一个获取列表的方法
26
- * @template T 列表项的类型
25
+ * 定义一个接口 `ApiList`,用于描述一个包含 `getList` 方法的对象。
26
+ * `getList` 方法用于获取数据列表,它接受一个可选的 `query` 参数,
27
+ * 并返回一个 `HttpRequestPromise` 或 `Promise`,其解析值为 `CombineInstanceType<T>[]` 类型的数组。
28
+ *
29
+ * @template T 一个泛型类型,必须是一个类类型。
27
30
  */
28
31
  export interface ApiList<T extends TypeWithPrototype = TypeWithPrototype> {
29
- getList(query?: any): HttpRequestPromise<CombineInstanceType<T>[]>;
32
+ /**
33
+ * 获取数据列表的方法。
34
+ *
35
+ * @param {any} [query] - 可选的查询参数。
36
+ * @returns {HttpRequestPromise<CombineInstanceType<T>[]> | Promise<CombineInstanceType<T>[]>} 返回一个 `HttpRequestPromise` 或 `Promise`,其解析值为 `CombineInstanceType<T>[]` 类型的数组。
37
+ */
38
+ getList(query?: any): HttpRequestPromise<CombineInstanceType<T>[]> | Promise<CombineInstanceType<T>[]>;
30
39
  }
31
40
  /**
32
41
  * Loader 的参数接口,包含 API 列表、全局标志、子键和加载完成的回调函数