mirrors/axios
2
0
Fork 0
mirror of https://github.com/tenrok/axios.git synced 2026-06-20 20:00:40 +03:00
Code Activity

Improve docs

Browse Source
This commit is contained in:
Nick Uraltsev
2016-09-20 19:54:24 -07:00
parent 5efca1ebbc
commit 920769d0d7
1 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -14
View File
@@ -466,22 +466,17 @@ axios.get('/user/12345', {
You can cancel a request using a *cancel token*. You can cancel a request using a *cancel token*.
> The axios cancel token API is based on [cancelable promises proposal](https://github.com/tc39/proposal-cancelable-promises), which is currently at Stage 1. > The axios cancel token API is based on the [cancelable promises proposal](https://github.com/tc39/proposal-cancelable-promises), which is currently at Stage 1.
You can create a cancel token by passing an executor function to the `CancelToken` constructor as shown below: You can create a cancel token using the `CancelToken.source` factory as shown below:
```js ```js
var Cancel = axios.Cancel; var Cancel = axios.Cancel;
var CancelToken = axios.CancelToken; var CancelToken = axios.CancelToken;
var source = CancelToken.source();
var cancel;
axios.get('/user/12345', { axios.get('/user/12345', {
cancelToken: new CancelToken(function executor(c) { cancelToken: source.token
// An executor function receives a cancel function as a parameter
// You can use the cancel function to cancel the request later
cancel = c;
})
}).catch(function(thrown) { }).catch(function(thrown) {
if (thrown instanceof Cancel) { if (thrown instanceof Cancel) {
console.log('Request canceled', thrown.message); console.log('Request canceled', thrown.message);
@@ -491,20 +486,24 @@ axios.get('/user/12345', {
}); });
// cancel the request (the message parameter is optional) // cancel the request (the message parameter is optional)
cancel('Operation canceled by the user.'); source.cancel('Operation canceled by the user.');
``` ```
You can also create a cancel token using the `CancelToken.source` factory: You can also create a cancel token by passing an executor function to the `CancelToken` constructor:
```js ```js
var CancelToken = axios.CancelToken; var CancelToken = axios.CancelToken;
var source = CancelToken.source(); var cancel;
axios.get('/user/12345', { axios.get('/user/12345', {
cancelToken: source.token cancelToken: new CancelToken(function executor(c) {
// An executor function receives a cancel function as a parameter
cancel = c;
})
}); });
source.cancel(); // cancel the request
cancel();
``` ```
## Semver ## Semver