xxf_react 0.2.6 → 0.2.7

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.
@@ -0,0 +1,29 @@
1
+ /**
2
+ * 统一 API 响应格式
3
+ */
4
+ export interface ApiResponse<T> {
5
+ code: number;
6
+ message: string;
7
+ data: T;
8
+ }
9
+ /**
10
+ * 检查 API 响应是否成功
11
+ */
12
+ export declare function isApiSuccess(code: number): boolean;
13
+ /**
14
+ * API 错误类
15
+ */
16
+ export declare class ApiError extends Error {
17
+ code: number;
18
+ constructor(code: number, message: string);
19
+ }
20
+ /**
21
+ * 从 API 响应中json提取data字段数据,失败时抛出错误
22
+ * @deprecated 请使用 {@link getDataFieldOrThrow} 代替
23
+ */
24
+ export declare function getDataOrThrow<T>(response: ApiResponse<T>): T;
25
+ /**
26
+ * 从 API 响应中json提取data字段数据,失败时抛出错误
27
+ */
28
+ export declare function getDataFieldOrThrow<T>(response: ApiResponse<T>): T;
29
+ //# sourceMappingURL=ApiResponse.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ApiResponse.d.ts","sourceRoot":"","sources":["../../src/models/ApiResponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,CAAC,CAAA;CACV;AAGD;;GAEG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAElD;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,KAAK;IAC/B,IAAI,EAAE,MAAM,CAAA;gBAEA,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAK5C;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAE7D;AAGD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAKlE"}
@@ -0,0 +1,32 @@
1
+ /**
2
+ * 检查 API 响应是否成功
3
+ */
4
+ export function isApiSuccess(code) {
5
+ return code === 0 || code === 200;
6
+ }
7
+ /**
8
+ * API 错误类
9
+ */
10
+ export class ApiError extends Error {
11
+ constructor(code, message) {
12
+ super(`API Error: (${code}) ${message}`);
13
+ this.name = 'ApiError';
14
+ this.code = code;
15
+ }
16
+ }
17
+ /**
18
+ * 从 API 响应中json提取data字段数据,失败时抛出错误
19
+ * @deprecated 请使用 {@link getDataFieldOrThrow} 代替
20
+ */
21
+ export function getDataOrThrow(response) {
22
+ return getDataFieldOrThrow(response);
23
+ }
24
+ /**
25
+ * 从 API 响应中json提取data字段数据,失败时抛出错误
26
+ */
27
+ export function getDataFieldOrThrow(response) {
28
+ if (!isApiSuccess(response.code)) {
29
+ throw new ApiError(response.code, response.message);
30
+ }
31
+ return response.data;
32
+ }
@@ -1,3 +1,4 @@
1
1
  export * from './ApiPageDataFieldDTO';
2
2
  export * from './PaginationDTO';
3
+ export * from './ApiResponse';
3
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC"}
@@ -1,2 +1,3 @@
1
1
  export * from './ApiPageDataFieldDTO';
2
2
  export * from './PaginationDTO';
3
+ export * from './ApiResponse';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "xxf_react",
3
- "version": "0.2.6",
3
+ "version": "0.2.7",
4
4
  "private": false,
5
5
 
6
6
  "type": "module",