mirror of
https://github.com/tenrok/axios.git
synced 2026-06-20 20:00:40 +03:00
Updating README
This commit is contained in:
@@ -1,4 +1,9 @@
|
|||||||
# axios [](https://travis-ci.org/mzabriskie/axios)
|
#axios
|
||||||
|
|
||||||
|
[](https://www.npmjs.org/package/axios)
|
||||||
|
[](https://www.npmjs.org/package/axios)
|
||||||
|
[](https://travis-ci.org/mzabriskie/axios)
|
||||||
|
[](https://david-dm.org/mzabriskie/axios)
|
||||||
|
|
||||||
Promise based HTTP client for the browser and node.js
|
Promise based HTTP client for the browser and node.js
|
||||||
|
|
||||||
@@ -7,6 +12,7 @@ Promise based HTTP client for the browser and node.js
|
|||||||
- Make [XMLHttpRequests](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) from the browser
|
- Make [XMLHttpRequests](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) from the browser
|
||||||
- Make [http](http://nodejs.org/api/http.html) requests from node.js
|
- Make [http](http://nodejs.org/api/http.html) requests from node.js
|
||||||
- Supports the [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) API
|
- Supports the [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) API
|
||||||
|
- Intercept request and response
|
||||||
- Transform request and response data
|
- Transform request and response data
|
||||||
- Automatic transforms for JSON data
|
- Automatic transforms for JSON data
|
||||||
- Client side support for protecting against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
|
- Client side support for protecting against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
|
||||||
@@ -215,6 +221,37 @@ axios.get('/user/12345')
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Interceptors
|
||||||
|
|
||||||
|
You can intercept requests or responses before they are handled by `then` or `catch`.
|
||||||
|
|
||||||
|
```js
|
||||||
|
// Add a request interceptor
|
||||||
|
axios.interceptors.request.use(function (config) {
|
||||||
|
// Do something before request is sent
|
||||||
|
return config;
|
||||||
|
}, function (error) {
|
||||||
|
// Do something with request error
|
||||||
|
return Promise.reject(error);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Add a response interceptor
|
||||||
|
axios.interceptors.response.use(function (response) {
|
||||||
|
// Do something with response data
|
||||||
|
return response;
|
||||||
|
}, function (error) {
|
||||||
|
// Do something with response error
|
||||||
|
return Promise.reject(error);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
If you may need to remove an interceptor later you can.
|
||||||
|
|
||||||
|
```js
|
||||||
|
var myInterceptor = axios.interceptors.request.use(function () {/*...*/});
|
||||||
|
axios.interceptors.request.eject(myInterceptor);
|
||||||
|
```
|
||||||
|
|
||||||
## Handling Errors
|
## Handling Errors
|
||||||
|
|
||||||
```js
|
```js
|
||||||
@@ -235,7 +272,7 @@ axios.get('/user/12345')
|
|||||||
```
|
```
|
||||||
|
|
||||||
## TypeScript Definition
|
## TypeScript Definition
|
||||||
Axios includes a [TypeScript](http://typescriptlang.org) definition.
|
axios includes a [TypeScript](http://typescriptlang.org) definition.
|
||||||
```typescript
|
```typescript
|
||||||
/// <reference path="axios.d.ts" />
|
/// <reference path="axios.d.ts" />
|
||||||
import axios = require('axios');
|
import axios = require('axios');
|
||||||
|
|||||||
Reference in New Issue
Block a user