Axios Documentation

Axios is a promise-based HTTP client that works in both the browser and Node.js (isomorphic).

• In the browser, it uses XMLHttpRequest.
• In Node.js, it uses the native http module.

Key features include:

• Intercepting requests and responses.
• Automatic data transformation (JSON, Multipart/FormData, and URL-encoded).
• Request/Response data transformation.
• Request cancellation and timeouts.
• Automatic JSON handling in responses.
• Support for XSRF protection on the client side.
• Progress tracking for uploads and downloads.

It is important to distinguish between response timeouts and connection cancellations:

1. timeout property: Handles response timeouts. It defines how long the client waits for a response before timing out.
2. signal (AbortController) or cancelToken: Handles connection timeouts/cancellations. This allows you to proactively terminate a request (e.g., if the network is unreachable or the user cancels the action) to prevent the request from hanging indefinitely in the stack.

For complete coverage, you should combine timeout with an early cancellation method like signal.

The documentation translation system is based on configuration files and localized markdown files.

• Configuration Files: Each language requires a {language-shortcut}.lang.js file (e.g., en.lang.js).
• Content Files: The actual translated content resides in posts/{language-shortcut}/*.md (e.g., posts/en/).
• Language Codes: You must use the ISO 639-1 two-letter code for the {language-shortcut} (e.g., zh for Traditional Chinese, de for German).

A translation in the Axios documentation repository consists of two main parts:

1. A configuration file: {language-shortcut}.lang.js (e.g., en.lang.js or de.lang.js).
2. Translated document files: Located in posts/{language-shortcut}/*.md (e.g., posts/en or posts/de).

Note: {language-shortcut} must be the 2-letter ISO 639-1 code for your language.

Starting from v0.27.0, Axios automatically serializes plain objects into FormData if the Content-Type header is set to multipart/form-data. This allows you to pass nested objects and files directly in the request body without manually constructing a FormData instance.

import axios from 'axios';

axios.post('https://httpbin.org/post', {
  user: {
    name: 'Dmitriy'
  },
  file: fs.createReadStream('/foo/bar.jpg')
}, {
  headers: {
    'Content-Type': 'multipart/form-data'
  }
}).then(({data})=> console.log(data));

Starting from version v0.27.0, Axios supports automatic serialization of objects into multipart/form-data if you explicitly set the Content-Type header to multipart/form-data in your request config.

This allows you to pass nested objects and file streams directly in the request body.

import axios from 'axios';

axios.post('https://httpbin.org/post', {
  user: {
    name: 'Dmitriy'
  },
  file: fs.createReadStream('/foo/bar.jpg')
}, {
  headers: {
    'Content-Type': 'multipart/form-data'
  }
}).then(({data})=> console.log(data));

Axios provides several advanced capabilities for handling HTTP requests:

• Generates XMLHttpRequest for browsers.
• Generates http requests for Node.js.
• Supports the Promise API.
• Interceptors: Ability to intercept requests and responses.
• Data Transformation: Ability to transform request and response data.
• Request Cancellation: Support for canceling requests.
• Automatic JSON Transformation: Automatically converts JSON data.
• XSRF Protection: Client-side support to prevent Cross-Site Request Forgery.