@sdkset

Appearance

Module: core/useAxios ​

Classes ​

Interfaces ​

Functions ​

useAxios ​

▸ useAxios<T>(axiosInstance, option?): WrapperAxios<T>

返回一个axios包装器对象。 包装器对axios.get调用方式进行了简化。 使用TypeScript时，可以通过传递泛型参数控制请求config对象类型。

Example

ts
import type { CreateAxiosDefaults } from 'axios'
import type { AxiosInterceptor } from '@sdkset/core'

interface RequestConfig extends AxiosRequestConfig {
  custom: {
    noNeedToken?: boolean
    ...
  }
}

const axiosInstance = axios.create({ ... })
const interceptor: AxiosInterceptor = { ... }
const axios = useAxios<RequestConfig>(axiosInstance, { interceptor })

await axios.get('url', { ... }, config)
=> response...
import type { CreateAxiosDefaults } from 'axios'
import type { AxiosInterceptor } from '@sdkset/core'

interface RequestConfig extends AxiosRequestConfig {
  custom: {
    noNeedToken?: boolean
    ...
  }
}

const axiosInstance = axios.create({ ... })
const interceptor: AxiosInterceptor = { ... }
const axios = useAxios<RequestConfig>(axiosInstance, { interceptor })

await axios.get('url', { ... }, config)
=> response...

Default

ts
useAxios({
  config: {}, // 创建配置对象
  interceptor: {} // 拦截器对象
})
useAxios({
  config: {}, // 创建配置对象
  interceptor: {} // 拦截器对象
})

Type parameters ​

Name
T

Parameters ​

NameTypeDescription
axiosInstanceAxiosInstanceaxios 实例
option?CreateAxiosOption包装器选项

Returns ​

WrapperAxios<T>