@varlet/axle 0.0.23 → 0.0.24

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.
Files changed (3) hide show
  1. package/es/use.d.ts +10 -7
  2. package/es/use.js +22 -1
  3. package/package.json +2 -2
package/es/use.d.ts CHANGED
@@ -1,11 +1,11 @@
1
- import { type Ref, type UnwrapRef } from 'vue';
1
+ import { type Ref } from 'vue';
2
2
  import { type AxleRequestConfig, createFetchHelper, createModifyHelper } from './instance.js';
3
3
  export interface RunOptions<P> {
4
4
  url?: string;
5
5
  params?: P;
6
6
  config?: AxleRequestConfig;
7
7
  }
8
- export type Run<D, P> = (options?: RunOptions<P>) => Promise<UnwrapRef<D>>;
8
+ export type Run<D, P> = (options?: RunOptions<P>) => Promise<D>;
9
9
  export interface UseAxleOptions<D = any, R = any, P = Record<string, any>> {
10
10
  url: string;
11
11
  runner: ReturnType<typeof createFetchHelper> | ReturnType<typeof createModifyHelper>;
@@ -15,16 +15,19 @@ export interface UseAxleOptions<D = any, R = any, P = Record<string, any>> {
15
15
  immediate?: boolean;
16
16
  onBefore?(): void;
17
17
  onAfter?(): void;
18
- onTransform?(response: UnwrapRef<R>, prev: UnwrapRef<D>): UnwrapRef<D>;
19
- onSuccess?(response: UnwrapRef<R>): void;
18
+ onTransform?(response: R, prev: D): D;
19
+ onSuccess?(response: R): void;
20
20
  onError?(error: Error): void;
21
21
  }
22
22
  export type UseAxleReturn<D, P> = [
23
- data: Ref<UnwrapRef<D>>,
23
+ data: Ref<D>,
24
24
  run: Run<D, P>,
25
25
  extra: {
26
- loading: Ref<UnwrapRef<boolean>>;
27
- error: Ref<UnwrapRef<Error | undefined>>;
26
+ uploadProgress: Ref<number>;
27
+ downloadProgress: Ref<number>;
28
+ loading: Ref<boolean>;
29
+ error: Ref<Error | undefined>;
30
+ abort(): void;
28
31
  }
29
32
  ];
30
33
  export interface CreateUseAxleOptions {
package/es/use.js CHANGED
@@ -8,12 +8,30 @@ export function createUseAxle(options = {}) {
8
8
  const data = ref(initialData);
9
9
  const loading = ref(false);
10
10
  const error = ref();
11
+ const downloadProgress = ref(0);
12
+ const uploadProgress = ref(0);
13
+ let controller = new AbortController();
14
+ const abort = () => {
15
+ controller.abort();
16
+ };
11
17
  const run = (options = {}) => {
12
18
  var _a;
19
+ if (controller.signal.aborted) {
20
+ controller = new AbortController();
21
+ }
22
+ uploadProgress.value = 0;
23
+ downloadProgress.value = 0;
13
24
  const url = (_a = options.url) !== null && _a !== void 0 ? _a : initialUrl;
14
25
  onBefore();
15
26
  loading.value = true;
16
- return runner(url, options.params, options.config)
27
+ return runner(url, options.params, Object.assign({ signal: controller.signal, onUploadProgress(event) {
28
+ var _a;
29
+ uploadProgress.value = (_a = event.progress) !== null && _a !== void 0 ? _a : 0;
30
+ },
31
+ onDownloadProgress(event) {
32
+ var _a;
33
+ downloadProgress.value = (_a = event.progress) !== null && _a !== void 0 ? _a : 0;
34
+ } }, options.config))
17
35
  .then((response) => {
18
36
  data.value = onTransform(response, data.value);
19
37
  error.value = undefined;
@@ -43,6 +61,9 @@ export function createUseAxle(options = {}) {
43
61
  {
44
62
  loading,
45
63
  error,
64
+ uploadProgress,
65
+ downloadProgress,
66
+ abort,
46
67
  },
47
68
  ];
48
69
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@varlet/axle",
3
- "version": "0.0.23",
3
+ "version": "0.0.24",
4
4
  "description": "A useful axios helper",
5
5
  "type": "module",
6
6
  "main": "es/index.js",
@@ -38,7 +38,7 @@
38
38
  "@varlet/cli": "^2.11.8",
39
39
  "rimraf": "^5.0.1",
40
40
  "typescript": "^5.1.5",
41
- "vue": "^3.3.4"
41
+ "vue": "3.3.4"
42
42
  },
43
43
  "repository": {
44
44
  "type": "git",