创建一个 AxiosError 对象用于测试目的

Question

我正在寻找一种轻松创建的方法AxiosError（从 axios lib 本身或外部助手）

上下文。

我有一个我想测试的功能。

import { AxiosError } from 'axios';

export function isEmailConflict({ error }: { error: AxiosError<{ type?: string; message?: string }> }) {
// ...
}

到目前为止我是这样执行的

import { AxiosError } from 'axios';
// ...
  describe('isEmailConflict', () => {
    function newConflicError(): AxiosError {
      return {
        isAxiosError: true,
        name: '',
        message: '',
        toJSON: () => ({}),
        config: {},
        response: {
          data: { type: 'aa', message: 'bb' },
          status: 409,
          statusText: 'Conflict',
          headers: {},
          config: {},
        },
      };
    }

    it('should return true if the passed error is of type email already used', () => {
      const error = newConflicError();
      //...
    });

但我觉得它很难看，有没有一种简单的方法来创建一个AxiosError？

我已经尝试过ts-auto-mock但我发现它对我的测试配置来说太侵入性了。

Answer 1

从axiosv1.0.0 开始，它添加了AxiosErrorto AxiosStatic，请参阅PR。

// Expose AxiosError class
axios.AxiosError = require('../lib/core/AxiosError');

AxiosError这意味着您可以从模块导入类axios并直接创建axios错误实例。它可能对测试有用。

例如（使用axios 1.3.4）

import { AxiosError, AxiosHeaders } from "axios";

var request = { path: "/foo" };
const headers = new AxiosHeaders();
const config = {
  url: "http://localhost:3000",
  headers
};
var error = new AxiosError("Boom!", "ESOMETHING", config, request, {
  status: 200,
  data: { foo: "bar" },
  statusText: "ok",
  config,
  headers
});

console.log("axios error: ", error);

export function isEmailConflict(error: AxiosError) {
  // ...
}
isEmailConflict(error);

代码沙盒

Answer 2

与此同时，我不得不切换到TypeScript，这是对我有用的解决方案（没有axios-error）：

import axios, { AxiosRequestConfig, AxiosResponse } from "axios";
import { AxiosError } from "axios";

[...]

  const responseData = "some string";
  const response: AxiosResponse = {
    data: responseData,
    status: 500,
  } as AxiosResponse;
  const axiosError = {
    config: {},
    request: {},
    response: response} as AxiosError<any>;