Create an AxiosError object for test purpose

Viewed 898

I am looking for a way to easily create AxiosError (from the axios lib itself or an external helper)

The context.

I have this function that I want to test.

import { AxiosError } from 'axios';

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

So far I performed it in this way

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();
      //...
    });

but I find it ugly, is there an easy way to create an AxiosError ?

I already tried ts-auto-mock but I find it too intrusive in my tests config.

2 Answers

Meanwhile, I had to switch to TypeScript, where this is the solution that worked for me (without 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>;
Related