Shortcuts for Axios.
## Compare to Axios
| Axios | Axios Instance | Axios Shortcut |
| ---------------------------- | ---------------------------- | ------------------------------------ |
| - | getUri([config]) | - |
| request(config) | request(config) | - |
| get(url[, config]) | get(url[, config]) | **GET(url[, params[, config]])** |
| delete(url[, config]) | delete(url[, config]) | **DELETE(url[, params[, config]])** |
| head(url[, config]) | head(url[, config]) | **HEAD(url[, params[, config]])** |
| options(url[, config]) | options(url[, config]) | **OPTIONS(url[, params[, config]])** |
| post(url[, data[, config]]) | post(url[, data[, config]]) | POST(url[, data[, config]]) |
| put(url[, data[, config]]) | put(url[, data[, config]]) | PUT(url[, data[, config]]) |
| patch(url[, data[, config]]) | patch(url[, data[, config]]) | PATCH(url[, data[, config]]) |
| - | - | DOWNLOAD(url[, fileName]) |
## Install
### NPM
```shell
npm i axios-shortcut
```
### CDN + ESM
```html
```
### CDN + IIFE
```html
```
## Usage
### Create from Axios
```ts
import axios from 'axios'
import AxiosShortcut from 'axios-shortcut'
const axiosShortcut = AxiosShortcut(axios)
```
### Create from Axios Instance
```ts
import request from '@/utils/request'
import AxiosShortcut from 'axios-shortcut'
const axiosShortcut = AxiosShortcut(request)
```
### Register as Global Properties in Vue
```ts
for (const k in axiosShortcut) {
// Vue 3
app.config.globalProperties[`$${k}`] = axiosShortcut[k]
// Vue 2
Object.defineProperty(Vue.prototype, `$${k}`, {
value: axiosShortcut[k]
})
}
```
## Upload
Request Header: `Content-Type: multipart/form-data`
```ts
(url: string, dataOrParams?: any, config?: AxiosRequestConfig) => Promise>
```
- `PUT.upload`
- `POST.upload`
- `PATCH.upload`
## Download
responseType: `'blob'`
Note the default value of `XMLHttpRequest.responseType` is `'text'`
And the default value of `AxiosRequestConfig.responseType` is `'json'`
```ts
(url: string, dataOrParams?: any, config?: AxiosRequestConfig) => Promise>
```
- `GET.download`
- `POST.download`
- `PATCH.download`
- `OPTIONS.download`
## Download Static Resources
Response Header: `Content-Disposition: attachment`
```ts
(url: string, fileName = '') => undefined
```
### Remote Static Resources (URLs)
```ts
DOWNLOAD('https://xxx.jpg', 'xxx.jpg')
```
### Local Static Resources (Object URLs)
```ts
// Plain Text
const text = 'Hello World'
const objectURL = URL.createObjectURL(new Blob([text], { type: 'text/plain' }))
DOWNLOAD(objectURL, 'xxx.txt')
// JSON
const json = { hello: 'world' }
const objectURL = URL.createObjectURL(new Blob([JSON.stringify(json)], { type: 'application/json' }))
DOWNLOAD(objectURL, 'xxx.json')
```
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/cloydlau/axios-shortcut/releases)
