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

Updating README

Browse Source
This commit is contained in:
Matt Zabriskie
2014-08-29 01:23:48 -06:00
parent 774b8c8e85
commit 5e6e269b54
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -12
View File
@@ -47,9 +47,9 @@ axios.post('/user', {
## Request API ## Request API
Requests can be made by passing the relevant options to `axios`. Requests can be made by passing the relevant config to `axios`.
##### axios(options) ##### axios(config)
```js ```js
axios({ axios({
@@ -62,17 +62,17 @@ axios({
For convenience aliases have been provided for all supported request methods. For convenience aliases have been provided for all supported request methods.
##### axios.get(url[, options]) ##### axios.get(url[, config])
##### axios.delete(url[, options]) ##### axios.delete(url[, config])
##### axios.head(url[, options]) ##### axios.head(url[, config])
##### axios.post(url[, data[, options]]) ##### axios.post(url[, data[, config]])
##### axios.put(url[, data[, options]]) ##### axios.put(url[, data[, config]])
##### axios.patch(url[, data[, options]]) ##### axios.patch(url[, data[, config]])
###### NOTE ###### NOTE
When using the alias methods `url`, `method`, and `data` properties don't need to be specified in options. When using the alias methods `url`, `method`, and `data` properties don't need to be specified in config.
### Options ### Config
```js ```js
{ {
@@ -117,7 +117,7 @@ When using the alias methods `url`, `method`, and `data` properties don't need t
withCredentials: true, withCredentials: true,
// `responseType` indicates the type of data that the server will responsd with // `responseType` indicates the type of data that the server will responsd with
// options are 'arraybuffer', 'blob', 'document', 'json', 'text' // config are 'arraybuffer', 'blob', 'document', 'json', 'text'
responseType: 'json' responseType: 'json'
} }
``` ```
@@ -137,7 +137,7 @@ For either `success` or `error`, the following response will be provided.
// `headers` the headers that the server responded with // `headers` the headers that the server responded with
headers: {/*...*/}, headers: {/*...*/},
// `config` are the options that were provided to `axios` for the request // `config` are the config that were provided to `axios` for the request
config: {/*...*/} config: {/*...*/}
} }
``` ```