2.0.0 • Published 2 years ago
@fatcherjs/middleware-aborter v2.0.0
@fatcherjs/middleware-aborter
A middleware for aborting fatcher request.
Install
NPM
>$ npm install @fatcherjs/middleware-aborter
CDN
<script src="https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/aborter.min.js"></script>
Usage
import { aborter, isAbortError } from '@fatcherjs/middleware-aborter';
import { fatcher } from 'fatcher';
fatcher({
url: '/bar/foo',
middlewares: [
aborter({
timeout: 10 * 1000, // 10s
onAbort: () => {
console.log('Request is Aborted.');
},
}),
],
})
.then(res => {
// Request success in 10s
console.log(res);
})
.catch(err => {
if (isAbortError(err)) {
//Run error when request aborted.
console.error(err);
}
// Other errors.
});
Options
Name | Description | Type | DefaultValue |
---|---|---|---|
timeout | If timeout > 0 , will abort this request later | number | 0 |
onAbort | A callback when aborting this request | (() => void) \| null | null |
concurrency | Request concurrency restrictions | boolean | false |
groupBy | Concurrency key | (context: Readonly<Context>) => string | ${context.url}_${context.method}_${new URLSearchParams(context.params).toString()} |