axios-cancel
Simplify cancellation of http requests when using the awesome axios library
Installation
Using npm:
npm install axios-cancel --save
Getting started
axios-cancel
simplifies the interface of the Cancel api introducted in axios v1.5,
which is based on the cancelable promises proposal
;; ; ... // Single request cancellationconst requestId = 'my_sample_request';const promise = axios ; axios;// aborts the HTTP request and logs `request cancelled`
Examples
Multiple subsequent requests with same requestId
... const requestId = 'my_sample_request';const promise1 = axios ; // another request with same `requestId`, before `promise1` resolutionconst promise2 = axios ; // aborts the first HTTP request, and cancels the first promise // logs `request 1 cancelled`// logs `resolved promise 2`
Multiple requests with different requestId
, cancell all
... const requestId1 = 'my_sample_request_1';const promise1 = axios ; const requestId2 = 'my_sample_request_2';const promise2 = axios ; axios; // aborts all HTTP request, and cancels all promises// logs `request 1 cancelled`// logs `request 2 cancelled`
Methods
axiosCancel(instance: axios[, options])
options
- debug (enables logging)
axios.cancel(requestId: string[, reason: string])
axios.cancelAll([reason: string])
License
MIT