@fatcherjs/middleware-aborter 1.6.0 → 1.7.1

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 (2) hide show
  1. package/README.md +6 -33
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -49,39 +49,12 @@ fatcher({
49
49
 
50
50
  ## Options
51
51
 
52
- ### timeout
53
-
54
- - Type: `number`
55
- - DefaultValue: `0`
56
- - Description:
57
-
58
- If `timeout > 0`, will abort this request later.
59
-
60
- Aborted request will throw a DOMException which can use `isAbortError` to confirm.
61
-
62
- ### onAbort
63
-
64
- - Type: `(() => void) | null`
65
- - DefaultValue: `null`
66
- - Description:
67
-
68
- A callback when aborting this request.
69
-
70
- ### concurrency
71
-
72
- - Type: `boolean`
73
- - DefaultValue: `false`
74
- - Description:
75
-
76
- Request concurrency restrictions
77
-
78
- ### groupBy
79
-
80
- - Type: `(context: Readonly<Context>) => string;`
81
- - DefaultValue: `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}`
82
- - Description:
83
-
84
- Concurrency key.
52
+ | Name | Description | Type | DefaultValue |
53
+ | ----------- | ----------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------ |
54
+ | timeout | If `timeout > 0`, will abort this request later | `number` | `0` |
55
+ | onAbort | A callback when aborting this request | `(() => void) \| null` | `null` |
56
+ | concurrency | Request concurrency restrictions | `boolean` | `false` |
57
+ | groupBy | Concurrency key | `(context: Readonly<Context>) => string` | `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}` |
85
58
 
86
59
  ## License
87
60
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fatcherjs/middleware-aborter",
3
- "version": "1.6.0",
3
+ "version": "1.7.1",
4
4
  "main": "dist/aborter.js",
5
5
  "module": "dist/aborter.esm.js",
6
6
  "browser": "dist/aborter.min.js",
@@ -15,7 +15,7 @@
15
15
  "url": "git+https://github.com/fatcherjs/fatcher.git"
16
16
  },
17
17
  "dependencies": {
18
- "fatcher": "^1.6.0"
18
+ "fatcher": "^1.7.1"
19
19
  },
20
20
  "scripts": {
21
21
  "dev": "rimraf dist && rollup -c rollup.config.ts -w",