使用ts封装axios时增加的一些类型判断

12 篇文章 0 订阅

我在ts项目中使用axios时,遇到两个困惑

  1. 在定义接口时,写method选项没有提示,容易写错
  2. 写拦截器时针对自己定义的一些配置选项没有提示或编译报错
  3. 接口返回的数据没有类型提示

针对以上两三点做了以下封装

import axios from 'axios'
import type { InternalAxiosRequestConfig, AxiosResponse, Method, AxiosRequestConfig } from 'axios'
//创建axios实例
const service = axios.create({
  timeout: 20000,
  baseURL: '/test',
  headers: { 'Content-Type': 'application/json;charset=utf-8' }
})

declare module 'axios' {
//这里扩展里InternalAxiosRequestConfig类型
  interface InternalAxiosRequestConfig<D = any> {
    loading?: boolean
    method: Method
  }
}

//请求拦截器
service.interceptors.request.use(
  //这里的config不能使用自己的类型,因为源码里写死了InternalAxiosRequestConfig类型
  //使用自己的类型,编译会报错
  (config: InternalAxiosRequestConfig) => {
    //这里config.loading是会有提示,不会报错的
    return config
  },
  (error: any) => {
    return Promise.reject(error)
  }
)



/**
* 这里使用了Omit类型,排除了InternalAxiosRequestConfig的必填选项headers
 * 这个函数有两个作用
 * 1.限制method选项的类型,同时编译器也会对method的值有提示
 * 2.对返回数据做了类型推断
 */
export function fetchApi<T = any, R = BaseResult, D = any>(
  config: Omit<InternalAxiosRequestConfig<D>, 'headers'>
): Promise<R> {
  return service<T, R, D>(config)
}
}

在上面做的一个补充之外,还可以正常做axios的拦截器

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值