Axios

An adapter for Axios.

Types

type ApiAxiosError<T = unknown, D = unknown> = AxiosError<T, D>

getAxiosError

Handles Axios response errors, transport failures, and other thrown values. Axios cancellations map to abort; errors with the explicit ETIMEDOUT code map to timeout.

• Type:

function getAxiosError<
  TCustomKind extends string = never,
  TValidationErrors = ApiValidationErrors,
>(
  error: unknown,
  options?: OkapiErrorAdapterOptions<TCustomKind, TValidationErrors>,
): OkapiError<TCustomKind, TValidationErrors>

createAxiosErrorMapper

Creates a mapper for Axios response errors, transport failures, and other thrown values.

• Type:

function createAxiosErrorMapper<
  TCustomKind extends string = never,
  TValidationErrors = ApiValidationErrors,
>(
  options?: OkapiErrorAdapterOptions<TCustomKind, TValidationErrors>,
): OkapiErrorMapper<TCustomKind, TValidationErrors>

Example

import axios from 'axios'
import { createAxiosErrorMapper } from '@alexovn/okapi/axios'

const mapAxiosError = createAxiosErrorMapper()

async function axiosGet<T>(url: string): Promise<T> {
  try {
    const response = await axios.get<T>(url)
    return response.data
  } catch (error) {
    throw mapAxiosError(error)
  }
}

Axios exposes the parsed error response body to the adapter automatically. This example throws a mapped object to its caller. If your application expects native Error instances, use getAxiosError instead, then map the error at the UI boundary.

Axios can use ECONNABORTED for both a timeout and an XHR abort. Okapi maps that ambiguous code to network. To distinguish Axios timeouts, enable transitional.clarifyTimeoutError in Axios so timeouts use ETIMEDOUT.