An helper to mock Axios requests while prototyping

axios-mock.ts

import { AxiosResponse } from 'axios';

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const createResponseStub: <T = any>(data?: T) => AxiosResponse = (data) => ({
  config: {},
  data,
  status: 200,
  statusText: '',
  headers: {},
});

/**
 * Simulate an asyncronous request to the server and provide an Axios-compatible response.
 * It allows you to write services for backend endpoints not ready yet.
 * When the actual endpoint is ready, you can then just swap the mockRequest
 * with the axios request and the nearby code won't have to change.
 *
 * @param options Define the returned data and/or timeout of the stub
 * @returns A successful axios response
 *
 * @example
 * const { data } = await mockRequest({ data: { id: 123, name: 'Test' } });
 * // Later on you can swap it with an axios request
 * const { data } = await webApi.get(`formulas/${formulaId}`);
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function mockRequest<T = any>(options: { data?: T; timeout?: number }) {
  return new Promise<AxiosResponse<T>>((resolve) =>
    setTimeout(
      () => resolve(createResponseStub(options.data)),
      options.timeout ?? 2000
    )
  );
}