1.0.6 • Published 13 days ago
alloy-request v1.0.6
alloy-request
alloy-request 基于axios
和ahooks的useRequest
封装的 react 请求库
安装
alloy-request 依赖 axios
和 ahooks的useRequest
,使用前请先安装 3.0 版本以上的ahooks和axios
npm install alloy-request
yarn add alloy-request
pnpm install alloy-request
初始化实例 API
参数 | 描述 | 类型 | 是否必填 | 默认值 |
---|---|---|---|---|
request | 实例 request 拦截器 | (req: AxiosRequestConfig) => AxiosRequestConfig | 否 | -- |
response | 实例 response 拦截器 | (req: AxiosResponse) => AxiosResponse | 否 | -- |
demo
import { initInstance } from 'alloy-request'
initInstance()
import { initInstance } from 'alloy-request'
initInstance(
(request) => {
request.baseURL = 'http://127.0.0.1:80'
return request
},
(response) => {
return response.data
}
)
GET API
参数 | 描述 | 类型 | 是否必填 | 默认值 |
---|---|---|---|---|
url | 请求的地址 | string | 是 | -- |
data | 请求的数据 | Record<string, any> | 否 | -- |
config | 请求的配置信息 | Record<string, any> | 否 | -- |
demo
import { get } from 'alloy-request';
async function getData() {
try {
const res = await get('api-url', { query: 'keyword' }, {})
console.log(res)
} catch(error){}
}
POST API
参数 | 描述 | 类型 | 是否必填 | 默认值 |
---|---|---|---|---|
url | 请求的地址 | string | 是 | -- |
data | 请求的数据 | Record<string, any> | 否 | -- |
config | 请求的配置信息 | Record<string, any> | 否 | -- |
demo
import { post } from 'alloy-request';
async function getData() {
try {
const res = await post('api-url', { name: 'name' }, {})
} catch(error){}
}
useAxios API
基于 ahooks useRequest 封装的参数请求 在 hooks 中使用 使用方法参照useRequest
参数 | 描述 | 类型 | 是否必填 | 默认值 |
---|---|---|---|---|
url | 请求的地址 | string | 是 | -- |
service | useRequest server | (...args: TParams) => Promise<TData> | 是 | -- |
options | useRequest options | Record<string, any> | 否 | -- |
demo
import { useAxios } from 'alloy-request';
const { runAsync } = useAxios('/getDemo', () => ({
method: 'post',
payload: { name: '' },
}), {
manual: true,
formatResult: (res) => {
return res
},
onSuccess: (res) => {
console.log(res)
}
})