https://github.com/z41z/foraxios
Easy axios to use.
https://github.com/z41z/foraxios
axios easy-axios foraxios
Last synced: 22 days ago
JSON representation
Easy axios to use.
- Host: GitHub
- URL: https://github.com/z41z/foraxios
- Owner: z41z
- License: mit
- Created: 2023-07-22T03:59:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-22T06:03:42.000Z (almost 3 years ago)
- Last Synced: 2025-11-10T21:36:44.262Z (8 months ago)
- Topics: axios, easy-axios, foraxios
- Language: JavaScript
- Homepage:
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# foraxios
Easy Axios to use.
## Install
``` node
npm i foraxios //or yarn add foraxios
```
### Usage
``` js
import ForAxios from 'foraxios';
// Message is unnecessary
import { Message } from 'element-ui';
const foraxios = new ForAxios({
// Request handler
request(config) {
// config content is api request content.
if (config.isOpenApi === undefined) {
config.headers = {
'token': `Bearer ${localStorage.access_token}`
}
}
},
// Request success handler
success(res) {
// res is api data returned
if (res.code !== 0) {
Message.error(res.msg)
}
return {
...res,
isSuccess: true
}
},
// Request error handler
error(err) {
Message.error(err)
return err
}
})
// Common request
const login = (data) => {
return foraxios.$api(
{
url: `/api/login`,
method: 'post',
data,
name: '用户登录'
}
)
}
// Donwload binary file
const exportFile = (data) => {
return foraxios.$api(
{
url: `/api/export`,
data: {
...data,
fileName: 'export.xlsx'
},
name: 'export file',
type: 'file'
}
)
}
```
### Base Config `Object`
- {Function} request = (config) => { } :`Request handler.`
- {Function} success = (res) => { } :`Request success handler.`
- {Function} error = (err) => { } :`Request error handler.`
- {Number} timeout = 10e3 :`Request timeout.`
- {Object} headers :`Request.`
- {Boolean} isShowConsole = true :`Is show message on console.`
### Request API Config `Object`
- {String} url :`Request url.`
- {*} data :`Request data.`
- {String} name :`API name.`
- {String} method = 'get' :`Request method.`
- {String} type :`Set value 'file' then download binary file.`
- {*} mockData :`Mock Data`